From f0252f750c5b54fc0d61b387c3260ba63bcbc3cc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Aug 2023 14:25:06 +0000 Subject: [PATCH 01/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 0304dfd..ad7889c 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1706d7b14d4ba9f749961e00b3e7209410fc1910 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 4 Aug 2023 14:26:49 +0000 Subject: [PATCH 02/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 39 files changed, 6208 insertions(+), 5030 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 5b35779..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 3d3cde1..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 334eb59..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 65d9d2d..9181b6e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d00742 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 4c579e3..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index d67a3f4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index ad7889c..365c2d7 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.0.2", - "@stdlib/array-base-zero-to": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-abs": "^0.0.6", - "@stdlib/utils-nary-function": "^0.0.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..74019cb --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 746d091c724d93e5be2f491e2fe3c9bf7313c547 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 10 Aug 2023 13:35:21 +0000 Subject: [PATCH 03/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4359860..1b88bcb 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6cb32a0a846d2b25213fa3b29b54b99f9f370706 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 10 Aug 2023 13:37:16 +0000 Subject: [PATCH 04/99] Remove files --- index.d.ts | 197 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6379 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 9181b6e..0000000 --- a/index.d.ts +++ /dev/null @@ -1,197 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection } from '@stdlib/types/object'; - -/** -* Five-dimensional nested array. -*/ -type Array5D = Array>>>>; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = () => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Collection, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Collection, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d00742..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 74019cb..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7b1f7ccb4512051f34189dc4526ec2498237e46e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 10 Aug 2023 13:38:02 +0000 Subject: [PATCH 05/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 798 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 39 files changed, 6208 insertions(+), 5030 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 5b35779..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 3d3cde1..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 334eb59..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,798 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Format error messages: - - name: 'Replace double quotes with single quotes in rewritten format string error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\( \"([a-zA-Z0-9]+)\"/Error\( format\( '\1'/g" {} \; - - # Format string literal error messages: - - name: 'Replace double quotes with single quotes in rewritten string literal error messages' - run: | - find . -name "*.js" -exec sed -E -i "s/Error\( format\(\"([a-zA-Z0-9]+)\"\)/Error\( format\( '\1' \)/g" {} \; - - # Format code: - - name: 'Replace double quotes with single quotes in inserted `require` calls' - run: | - find . -name "*.js" -exec sed -E -i "s/require\( ?\"@stdlib\/error-tools-fmtprodmsg\" ?\);/require\( '@stdlib\/error-tools-fmtprodmsg' \);/g" {} \; - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 65d9d2d..9181b6e 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection } from '@stdlib/types/object'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d00742 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 4c579e3..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index d67a3f4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 1b88bcb..40ac030 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.0.2", - "@stdlib/array-base-zero-to": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-abs": "^0.0.6", - "@stdlib/utils-nary-function": "^0.0.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7667e56 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 908348f0e9971da57fa35afac1cbb6bdcbab46a8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 10 Aug 2023 13:38:31 +0000 Subject: [PATCH 06/99] Update README.md for ESM bundle v0.0.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 9307d70..96ecacf 100644 --- a/README.md +++ b/README.md @@ -33,13 +33,13 @@ limitations under the License. ## Usage ```javascript -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.0.1-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.0.1-esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -150,7 +150,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.0.1-esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From 45fb085bed2d3fbaf2df8d6bc2820f712f143ea0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 10 Aug 2023 13:38:32 +0000 Subject: [PATCH 07/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 96ecacf..8cc555b 100644 --- a/README.md +++ b/README.md @@ -32,6 +32,11 @@ limitations under the License. ## Usage +```javascript +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-flatten5d-by/tags). For example, + ```javascript import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.0.1-esm/index.mjs'; ``` @@ -39,7 +44,7 @@ import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatte You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.0.1-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -150,7 +155,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.0.1-esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From ebcb7860ad2984c0ae92a7bf90dee1eeb9721206 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:23:54 +0000 Subject: [PATCH 08/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4359860..1b88bcb 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4b641652606355c8cf43fe5c34d6efd013f76be6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:28:03 +0000 Subject: [PATCH 09/99] Remove files --- index.d.ts | 197 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6379 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 9181b6e..0000000 --- a/index.d.ts +++ /dev/null @@ -1,197 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection } from '@stdlib/types/object'; - -/** -* Five-dimensional nested array. -*/ -type Array5D = Array>>>>; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = () => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Collection, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Collection, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d00742..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7667e56..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e4e79fc1314ea6c113ab0f0dfd0158a007676ce8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:28:38 +0000 Subject: [PATCH 10/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 42 files changed, 6208 insertions(+), 5032 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 5b35779..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 3d3cde1..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index b7cf3f1..c880cac 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d00742 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 4c579e3..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index d67a3f4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 1b88bcb..40ac030 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.0.2", - "@stdlib/array-base-zero-to": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-abs": "^0.0.6", - "@stdlib/utils-nary-function": "^0.0.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..b0b612d --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From b2a9b7d06f7ee0db7a42b365dfd92953baf70fae Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 10:10:07 +0000 Subject: [PATCH 11/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4359860..1b88bcb 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From c9eebf8970f2ac60108fd6a7217313d554e501d6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 10:28:39 +0000 Subject: [PATCH 12/99] Remove files --- index.d.ts | 197 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6379 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 c880cac..0000000 --- a/index.d.ts +++ /dev/null @@ -1,197 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection } from '@stdlib/types/array'; - -/** -* Five-dimensional nested array. -*/ -type Array5D = Array>>>>; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = () => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Collection, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Collection, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d00742..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index b0b612d..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e971ed4246f8fb4b8f2572fa59337a5882455e3b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 10:29:49 +0000 Subject: [PATCH 13/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 42 files changed, 6208 insertions(+), 5032 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 5b35779..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 3d3cde1..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index c17b146..6f559c7 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection } from '@stdlib/types/array'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d00742 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 4c579e3..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index d67a3f4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 1b88bcb..40ac030 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.0.2", - "@stdlib/array-base-zero-to": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-abs": "^0.0.6", - "@stdlib/utils-nary-function": "^0.0.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..55c213d --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From dcfb631bb4730f380f46d85b61054857900f8114 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 21:41:57 +0000 Subject: [PATCH 14/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4359860..1b88bcb 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From cfe4d0b7cdbbd47f5aec655e4bce5f39f4e939f1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 21:44:40 +0000 Subject: [PATCH 15/99] Remove files --- index.d.ts | 197 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6379 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 6f559c7..0000000 --- a/index.d.ts +++ /dev/null @@ -1,197 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection } from '@stdlib/types/array'; - -/** -* Five-dimensional nested array. -*/ -type Array5D = Array>>>>; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Collection, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Collection, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d00742..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 55c213d..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7c8cbf5728ec3e3edb9333cd44d5dda0b0b35d84 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 21:45:23 +0000 Subject: [PATCH 16/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 42 files changed, 6208 insertions(+), 5032 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0fd4d6c..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 5b35779..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 3d3cde1..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -233,7 +232,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d00742 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 4c579e3..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index d67a3f4..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 1b88bcb..40ac030 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.0.2", - "@stdlib/array-base-zero-to": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-abs": "^0.0.6", - "@stdlib/utils-nary-function": "^0.0.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..03c562a --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From d073441981e07021de142dd48eda595baaf8f877 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 26 Aug 2023 10:36:45 +0000 Subject: [PATCH 17/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4359860..1b88bcb 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 5f29cda8eb62587c9ee0c3462e45de51b4351272 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 26 Aug 2023 10:40:38 +0000 Subject: [PATCH 18/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d00742..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 03c562a..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b1e2bc080b6b64515516e63767adb66c6a8d11e5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 26 Aug 2023 10:41:37 +0000 Subject: [PATCH 19/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 43 files changed, 6208 insertions(+), 5067 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 5b35779..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 3d3cde1..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d00742 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 1b88bcb..40ac030 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.0.14", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.0.7", - "@stdlib/error-tools-fmtprodmsg": "^0.0.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.0.2", - "@stdlib/array-base-zero-to": "^0.0.6", - "@stdlib/array-float64": "^0.0.6", - "@stdlib/assert-has-own-property": "^0.0.7", - "@stdlib/assert-is-array": "^0.0.7", - "@stdlib/assert-is-float64array": "^0.0.8", - "@stdlib/bench": "^0.0.12", - "@stdlib/math-base-special-abs": "^0.0.6", - "@stdlib/utils-nary-function": "^0.0.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..2289251 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From b67c8467c19c7649878d33ee6095701a8727af13 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 06:41:06 +0000 Subject: [PATCH 20/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 50a8236..5c1d3b6 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.0" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 3311a878dd69cc109ed1167a1b1504a520288b25 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 08:58:56 +0000 Subject: [PATCH 21/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d00742..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 2289251..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ab29fd6e5255e9da1117186a2d286665095a2202 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 08:59:39 +0000 Subject: [PATCH 22/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 62 - .github/workflows/cancel.yml | 56 - .github/workflows/close_pull_requests.yml | 44 - .github/workflows/examples.yml | 62 - .github/workflows/npm_downloads.yml | 108 - .github/workflows/productionize.yml | 783 --- .github/workflows/publish.yml | 242 - .github/workflows/test.yml | 97 - .github/workflows/test_bundles.yml | 180 - .github/workflows/test_coverage.yml | 123 - .github/workflows/test_install.yml | 83 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 43 files changed, 6208 insertions(+), 5067 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 06a9a75..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index a00dbe5..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,56 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - uses: styfle/cancel-workflow-action@0.11.0 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 5b35779..0000000 --- a/.github/workflows/close_pull_requests.yml +++ /dev/null @@ -1,44 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: close_pull_requests - -# Workflow triggers: -on: - pull_request_target: - types: [opened] - -# Workflow jobs: -jobs: - run: - runs-on: ubuntu-latest - steps: - - uses: superbrothers/close-pull-request@v3 - with: - comment: | - Thank you for submitting a pull request. :raised_hands: - - We greatly appreciate your willingness to submit a contribution. However, we are not accepting pull requests against this repository, as all development happens on the [main project repository](https://github.com/stdlib-js/stdlib). - - We kindly request that you submit this pull request against the [respective directory](https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index 7902a7d..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,62 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout the repository' - uses: actions/checkout@v3 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 3d3cde1..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,108 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - uses: actions/upload-artifact@v3 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - uses: distributhor/workflow-webhook@v3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 91f2b93..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,783 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - uses: actions/checkout@v3 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/checkout@v3 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - uses: act10ns/slack@v2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - uses: actions/checkout@v3 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - uses: actions/setup-node@v3 - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7d00742 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 5c1d3b6..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.0.2", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.0", - "@stdlib/assert-is-float64array": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-abs": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a39ade5 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 984e10e34cd516d006cc1ea6370a15f888bb4964 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 10:48:34 +0000 Subject: [PATCH 23/99] Update README.md for ESM bundle v0.1.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index b6d6de5..957b657 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ limitations under the License. ## Usage ```javascript -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.1.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.1.0-esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +161,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.1.0-esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From 46c91833ba45506f6f7e198699f7ededad388910 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 10:48:35 +0000 Subject: [PATCH 24/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 957b657..e08ec6d 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,11 @@ limitations under the License. ## Usage +```javascript +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-flatten5d-by/tags). For example, + ```javascript import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.1.0-esm/index.mjs'; ``` @@ -50,7 +55,7 @@ import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatte You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.1.0-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +166,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.1.0-esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From 62af778b3aac4ccff3e34efe5abf1af88d484d90 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Oct 2023 14:18:32 +0000 Subject: [PATCH 25/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index e4b44b3..b844060 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0", + "@stdlib/error-tools-fmtprodmsg": "^0.1.0" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 40855911fb9098bd868dcb5ea644ef95538179f3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Oct 2023 22:32:48 +0000 Subject: [PATCH 26/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7d00742..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,g,j,v,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;iHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a39ade5..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 60ec37b2a6fdea63f122b917f5ee307ba05adccd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 2 Oct 2023 22:33:37 +0000 Subject: [PATCH 27/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 40 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 6208 insertions(+), 5166 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 208479a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-10-01T04:22:05.331Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index ed25e71..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8807dc5 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index b844060..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.0", - "@stdlib/error-tools-fmtprodmsg": "^0.1.0" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.0", - "@stdlib/assert-is-array": "^0.1.0", - "@stdlib/assert-is-float64array": "^0.1.0", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-abs": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7808fba --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index ac4c770..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 29533c13bc857f77bb3d5b35987d6c8a3bf6bbfd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 5 Oct 2023 17:44:16 +0000 Subject: [PATCH 28/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 3d057a4..6dcf7ef 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 0dac1c4e48a6afc8d32849f55b46702fa6bda5eb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 23:27:26 +0000 Subject: [PATCH 29/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8807dc5..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7808fba..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ce35bcffda5ddf9357e52b411bd84945727fc0cc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 6 Oct 2023 23:28:20 +0000 Subject: [PATCH 30/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 247 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 40 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 44 files changed, 6208 insertions(+), 5165 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index ed25e71..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8807dc5 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 6dcf7ef..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.0", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-abs": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f458cab --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index ac4c770..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 766a9be193c1e5a54afa67bb3d420741552a9f57 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Nov 2023 15:18:40 +0000 Subject: [PATCH 31/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b7867c2..3cd9ccc 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 15799d6cdbb3e828f61b4b93d0b963de0eab4495 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Nov 2023 22:46:57 +0000 Subject: [PATCH 32/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8807dc5..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f458cab..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2406cafdc2526f5d5d63d22ebd2d6e72c0e1f9b8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 2 Nov 2023 22:47:48 +0000 Subject: [PATCH 33/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 6208 insertions(+), 5167 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 3e3f11e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-11-01T04:37:17.805Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index ed25e71..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8807dc5 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 3cd9ccc..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.1.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/bench": "^0.1.0", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c4a30a6 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 8ee8eb345e494141f56615376ffded6d2426a4f1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 11:40:32 +0000 Subject: [PATCH 34/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9055008..22f8fd0 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9e47486ec25b87646cd7a9d3124d47f912902aef Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 08:41:14 +0000 Subject: [PATCH 35/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8807dc5..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c4a30a6..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d576a75c7ceda53c52d6f3f8a4791f6221abcff3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 08:41:52 +0000 Subject: [PATCH 36/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 6208 insertions(+), 5162 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 482ad21..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T04:48:57.316Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index ab56cca..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c1c45e7..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index ed25e71..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA corresponding to v3.0.3: - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 265afda..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA corresponding to v4.1.0 - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 16 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 41bf052..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var bench = require( '@stdlib/bench' ); -var isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..8807dc5 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 22f8fd0..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c9f8aa7 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From fb886f84e1bf738c1b3ee724b0e4e289989d8148 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 06:55:55 +0000 Subject: [PATCH 37/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9d8ec0c..aa58758 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e845dc64d3ddee5df12ea92eec3c521785ba8626 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 13:39:45 +0000 Subject: [PATCH 38/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 8807dc5..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c9f8aa7..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a0c88d3fd9a1ece8dcd096d51aeca2ce13ab732b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 13:39:57 +0000 Subject: [PATCH 39/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 6208 insertions(+), 5168 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 45a76f4..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T04:15:36.587Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 974234f..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index 5c33667..8157f0f 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c96dd96 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index aa58758..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..c5717e2 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 5c3eb8df47f3c4f25652d8935e6262977139d10d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:11:22 +0000 Subject: [PATCH 40/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9d8ec0c..aa58758 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4b8f8514be013eaa325660bc233d1088f49f0b47 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:19:07 +0000 Subject: [PATCH 41/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 8157f0f..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c96dd96..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index c5717e2..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4a8b538abbaa684651565bb4e580af23ca3f206f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:19:24 +0000 Subject: [PATCH 42/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 6208 insertions(+), 5167 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 974234f..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -244,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1308806..0000000 --- a/branches.md +++ /dev/null @@ -1,53 +0,0 @@ - - -# Branches - -This repository has the following branches: - -- **main**: default branch generated from the [stdlib project][stdlib-url], where all development takes place. -- **production**: [production build][production-url] of the package (e.g., reformatted error messages to reduce bundle sizes and thus the number of bytes transmitted over a network). -- **esm**: [ES Module][esm-url] branch for use via a `script` tag without the need for installation and bundlers. -- **deno**: [Deno][deno-url] branch for use in Deno. -- **umd**: [UMD][umd-url] branch for use in Observable, or in dual browser/Node.js environments. - -The following diagram illustrates the relationships among the above branches: - -```mermaid -graph TD; -A[stdlib]-->|generate standalone package|B; -B[main] -->|productionize| C[production]; -C -->|bundle| D[esm]; -C -->|bundle| E[deno]; -C -->|bundle| F[umd]; - -%% click A href "https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm \ No newline at end of file diff --git a/dist/index.d.ts b/dist/index.d.ts deleted file mode 100644 index 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c96dd96 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index aa58758..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..a503c19 --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 21adcde77b3ff4cb1ec9885f9b162ac26be42957 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 07:25:54 +0000 Subject: [PATCH 43/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9d8ec0c..aa58758 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1672cc87dcd0386f49f94367470569464b65c8ae Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 12:55:43 +0000 Subject: [PATCH 44/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c96dd96..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index a503c19..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9331ee070b804f532d225fdc65bef058778c6538 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 12:56:00 +0000 Subject: [PATCH 45/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 6208 insertions(+), 5173 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 8bb6d3c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-02-01T05:05:01.524Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index 30656c4..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index 3acd3a9..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA corresponding to v0.11.0 - uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. - - Thank you again, and we look forward to receiving your contribution! :smiley: - - Best, - The stdlib team \ No newline at end of file diff --git a/.github/workflows/examples.yml b/.github/workflows/examples.yml deleted file mode 100644 index c92f5c4..0000000 --- a/.github/workflows/examples.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: examples - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run the package examples... - examples: - - # Define display name: - name: 'Run examples' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - - # Checkout repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run examples: - - name: 'Run examples' - run: | - npm run examples diff --git a/.github/workflows/npm_downloads.yml b/.github/workflows/npm_downloads.yml deleted file mode 100644 index 974234f..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index e1e3539..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA corresponding to v3.8.1 - uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c96dd96 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index aa58758..acd7db4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", - "@stdlib/error-tools-fmtprodmsg": "^0.1.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.1.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1ad3d4e --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 215220b744b925f799af59b9d371175c1336e663 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 14:13:24 +0000 Subject: [PATCH 46/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 32980b0..42394fd 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-base-filled": "^0.1.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From c651f22d4799894c4dfcc7288b23d54c33e4186e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 21:04:35 +0000 Subject: [PATCH 47/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c96dd96..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1ad3d4e..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 542f483bf6d96f51a2ef048021aa7be8d3e222ad Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 21:04:51 +0000 Subject: [PATCH 48/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 6208 insertions(+), 5176 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 2a3f8b5..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA corresponding to v3.1.3 - uses: actions/upload-artifact@a8a3f3ad30e3422c9c7b888a15615d19a852ae32 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..c96dd96 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 42394fd..9198e1d 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", - "@stdlib/error-tools-fmtprodmsg": "^0.2.0" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.1.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.1.1", - "@stdlib/assert-has-own-property": "^0.1.1", - "@stdlib/assert-is-array": "^0.1.1", - "@stdlib/assert-is-float64array": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/utils-nary-function": "^0.2.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d79cb7e --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From fb889f21b23995382cc1df85560a3c85936d76d6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 22:10:19 +0000 Subject: [PATCH 49/99] Update README.md for ESM bundle v0.2.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index f6a1cb2..c79a820 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ limitations under the License. ## Usage ```javascript -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.0-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.0-esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +161,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.0-esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From b3a29dbf136d7a5ec12ca3f800f412701c31f9e8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 22:10:19 +0000 Subject: [PATCH 50/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index c79a820..3629b73 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,11 @@ limitations under the License. ## Usage +```javascript +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-flatten5d-by/tags). For example, + ```javascript import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.0-esm/index.mjs'; ``` @@ -50,7 +55,7 @@ import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatte You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.0-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +166,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.0-esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From 9b1350c2ef3fd066cf5338a0bd6f8f4b339858be Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 00:23:17 +0000 Subject: [PATCH 51/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 6fb4590..df85a46 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.0", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 87b2f6cf7824bfdd198d30201e4d7e0f1c3c9e51 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 05:44:17 +0000 Subject: [PATCH 52/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6375 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index c96dd96..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d79cb7e..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 1692ba5dc2e3eeaa91f87ff4cfeb7299e6736cd2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 05:44:33 +0000 Subject: [PATCH 53/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 4873 insertions(+), 5170 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index df85a46..e2755f8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.0", - "@stdlib/array-base-zero-to": "^0.2.0", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.0", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 8f50fa73cb35fc89f3fe344bea3afe611483685b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 07:25:31 +0000 Subject: [PATCH 54/99] Update README.md for ESM bundle v0.2.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 3717c54..9d27a6f 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ limitations under the License. ## Usage ```javascript -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.1-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.1-esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +161,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.1-esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From 8eb4699fe4dc5c50b7eba2d24b45c3f09fa8e8c1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 07:25:32 +0000 Subject: [PATCH 55/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9d27a6f..c68d6bf 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,11 @@ limitations under the License. ## Usage +```javascript +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-flatten5d-by/tags). For example, + ```javascript import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.1-esm/index.mjs'; ``` @@ -50,7 +55,7 @@ import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatte You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.1-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +166,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.1-esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From c1009e11b08b9d6ceaabd98471a8da7910cec687 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 06:48:13 +0000 Subject: [PATCH 56/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8af51c7..33415db 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.1", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From cbcac4a6fef00d612ec7162948b53fe7866d4623 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 12:15:03 +0000 Subject: [PATCH 57/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a8cc80c3376feadc7d21251b1bb193ec192e8e53 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 12:15:34 +0000 Subject: [PATCH 58/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4873 insertions(+), 5172 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 133da59..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T04:51:38.459Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 9106b5d..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA corresponding to v2.0.0 - uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 33415db..e2755f8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 6f6b7338427bbbf3ee03ec9c1e20adb3419e1a37 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 06:04:35 +0000 Subject: [PATCH 59/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8af51c7..33415db 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.1", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From f3edb2805e08cf71d79e5501fd58f7a8f14f1fe2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 11:14:14 +0000 Subject: [PATCH 60/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b98c3bfcacbb13d7356aa0b6a88cd24285490ca9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 11:14:23 +0000 Subject: [PATCH 61/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4873 insertions(+), 5175 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index aef3b13..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T04:06:48.224Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 33415db..e2755f8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From e2286635b0a113bb24f5b300cf37f50c56bbcda6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 02:27:51 +0000 Subject: [PATCH 62/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8af51c7..33415db 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.1", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9113a41d0cbaf08627dd51a22be28362580c2c68 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 07:54:31 +0000 Subject: [PATCH 63/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 87f10293e637db746b22b9458c23083799c24e08 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 07:54:47 +0000 Subject: [PATCH 64/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 134 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 4873 insertions(+), 5176 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index ec90164..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,797 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - steps: ${{ toJson(steps) }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure git: - - name: 'Configure git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 33415db..e2755f8 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/error-tools-fmtprodmsg": "^0.2.1" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.1", - "@stdlib/assert-has-own-property": "^0.2.1", - "@stdlib/assert-is-array": "^0.2.1", - "@stdlib/assert-is-float64array": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 299ea102250f300e17f0ea3645646c11a8e64c33 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:22:31 +0000 Subject: [PATCH 65/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 0e4e63d..453001f 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.1", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a76b3a31e555e8eae2be0b9a3f8793f20e78c751 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:36:33 +0000 Subject: [PATCH 66/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 64b1a9f3eb629d36bede946a8c853fcde65d886d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:36:47 +0000 Subject: [PATCH 67/99] Auto-generated commit --- .editorconfig | 181 - .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 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 151 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 4873 insertions(+), 5333 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 453001f..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.1", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From a7cac06ff9b152c81f25d4edc2f6117d32577960 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:45:25 +0000 Subject: [PATCH 68/99] Update README.md for ESM bundle v0.2.2 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index a479af5..f952ac6 100644 --- a/README.md +++ b/README.md @@ -44,13 +44,13 @@ limitations under the License. ## Usage ```javascript -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.2-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.2-esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +161,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.2-esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From fe99c7e3c0b3f3a496fe738f232180491305734f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:45:25 +0000 Subject: [PATCH 69/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f952ac6..53cfde8 100644 --- a/README.md +++ b/README.md @@ -43,6 +43,11 @@ limitations under the License. ## Usage +```javascript +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-flatten5d-by/tags). For example, + ```javascript import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.2-esm/index.mjs'; ``` @@ -50,7 +55,7 @@ import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatte You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.2-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; ``` #### flatten5dBy( x, shape, colexicographic, clbk\[, thisArg] ) @@ -161,7 +166,7 @@ y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@v0.2.2-esm/index.mjs'; +import flatten5dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten5d-by@esm/index.mjs'; var fcn = naryFunction( abs, 1 ); From 0f8ce4d4b033c29fdc8a8b00402864c291f05472 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 06:54:42 +0000 Subject: [PATCH 70/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 072eeb5..66bfd88 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1632c918da401852b805b3d84f1c4548c274e0cf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 11:32:57 +0000 Subject: [PATCH 71/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b282017d5f31d6357fef635eb29bf257a28913e7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 11:33:12 +0000 Subject: [PATCH 72/99] Auto-generated commit --- .editorconfig | 181 - .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 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 88 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4873 insertions(+), 5273 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 57c78c6..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-01T04:58:02.300Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 66bfd88..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 153e550eee97891ee506a3617ab5a92c5a63859d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 3 Aug 2024 22:06:44 +0000 Subject: [PATCH 73/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 072eeb5..66bfd88 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4bacc635c690d14a846261c87fb39370f0c7cf93 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Aug 2024 01:20:58 +0000 Subject: [PATCH 74/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9accf1b9501c1c2259cc48496ef5cf177a89da49 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Aug 2024 01:21:11 +0000 Subject: [PATCH 75/99] Auto-generated commit --- .editorconfig | 181 - .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 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 151 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4873 insertions(+), 5336 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 0c2f7fc..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-03T20:26:23.035Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 66bfd88..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From e02b4cd7201a48e79bc64c9c6d484de8a98b0202 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 07:13:33 +0000 Subject: [PATCH 76/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8580035..b5fbdf8 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a67a242c4b0aafe8a39bac1b8d56faa2d99c2a59 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 11:28:39 +0000 Subject: [PATCH 77/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0653a3f851ef8c5bf69b363e20623153bc5e1586 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 11:28:51 +0000 Subject: [PATCH 78/99] Auto-generated commit --- .editorconfig | 181 - .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 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 151 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4873 insertions(+), 5336 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 c05cf22..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-09-01T05:18:05.353Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 2631e7f..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param v - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index b5fbdf8..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 28ddda819cc1285fb068812248b748e695d54500 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 28 Sep 2024 21:16:16 +0000 Subject: [PATCH 79/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8580035..b5fbdf8 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 27bc5f5335fae5e99420aed1746130d04cf67d79 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 28 Sep 2024 21:19:42 +0000 Subject: [PATCH 80/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 31718da383944d226b108463038a12c82360ab3e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 28 Sep 2024 21:19:58 +0000 Subject: [PATCH 81/99] Auto-generated commit --- .editorconfig | 181 - .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 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 185 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 45 files changed, 4873 insertions(+), 5369 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7fc978..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param value - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index b5fbdf8..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 461e98e93c06e3f951dbfca442685230f56af13e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 07:29:31 +0000 Subject: [PATCH 82/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8580035..b5fbdf8 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a18a3b75b6ffdf4b93620075e43a9a19472bd24f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 12:06:16 +0000 Subject: [PATCH 83/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From fe711dc9c88aeaedb0d00d1e0023402d37530da7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 12:06:30 +0000 Subject: [PATCH 84/99] Auto-generated commit --- .editorconfig | 181 - .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 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 185 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4873 insertions(+), 5370 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 3a274ba..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-10-01T05:29:52.477Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7fc978..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param value - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index b5fbdf8..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 8b0846d16e37a9c49ca04d3a648d558db3c5c6e8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 07:21:53 +0000 Subject: [PATCH 85/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8580035..b5fbdf8 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 635f5e8ddd5a465f22e6b04982c16dabe9498e01 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 11:18:36 +0000 Subject: [PATCH 86/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d13fa3d5be81c8c94ea8ed098a3d4c4d166912b9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 11:18:48 +0000 Subject: [PATCH 87/99] Auto-generated commit --- .editorconfig | 181 - .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 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 185 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4873 insertions(+), 5370 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 5f977c5..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-11-01T05:33:46.253Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7fc978..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param value - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index b5fbdf8..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From eb8ce521bd9324438c3173bb39d744b99446ddcc Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 07:37:39 +0000 Subject: [PATCH 88/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 24dd9c4..579c1fa 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 70a89bab9b9d74c9bf4cf5e844c1f42403446a23 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 11:30:51 +0000 Subject: [PATCH 89/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From ce193594612f10f0d80cfa52a5a4718dd4503c19 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 11:31:07 +0000 Subject: [PATCH 90/99] Auto-generated commit --- .editorconfig | 181 - .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 | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 185 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 47 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 47 files changed, 4873 insertions(+), 5475 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 (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 aa9bb2c..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-01T05:42:20.140Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -246,7 +243,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. 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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7fc978..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param value - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 579c1fa..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From a1407af24e8911298e6cf4f36818bd2a15c240b0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Dec 2024 03:13:39 +0000 Subject: [PATCH 91/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 24dd9c4..579c1fa 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9776956beb9e69672a0ee53af65b16ef7837ec1b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Dec 2024 03:14:27 +0000 Subject: [PATCH 92/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5a924840d77a023fe52baab8c93c275b9fe431a5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 14 Dec 2024 03:14:42 +0000 Subject: [PATCH 93/99] Auto-generated commit --- .editorconfig | 181 - .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 | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 186 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 46 files changed, 4874 insertions(+), 5476 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 (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 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 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -252,7 +249,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. @@ -317,7 +314,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/array-base-flatten5d +[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/array-base-flatten5d/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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7fc978..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param value - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6c104e2 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 579c1fa..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From 7d0f1fa484bc4636b2f3ab0b0598428074aca5ce Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Feb 2025 00:28:52 +0000 Subject: [PATCH 94/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 24dd9c4..579c1fa 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 75061002f34794d7f0f9b81c17b25b1fdf6a164c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Feb 2025 00:32:56 +0000 Subject: [PATCH 95/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6c104e2..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 71ef4531dbd1f0ecf28005eb3c48baa73c084440 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Feb 2025 00:33:11 +0000 Subject: [PATCH 96/99] 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 | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 186 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 47 files changed, 4874 insertions(+), 5476 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 (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index bc24cf0..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-02-10T00:28:19.706Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 0ed574e..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/array/base/flatten5d-by) of the main repository where we’ll review and provide feedback. - -If this is your first stdlib contribution, be sure to read the [contributing guide](https://github.com/stdlib-js/stdlib/blob/develop/CONTRIBUTING.md) which provides guidelines and instructions for submitting contributions. You may also consult the [development guide](https://github.com/stdlib-js/stdlib/blob/develop/docs/development.md) for help on developing stdlib. - -We look forward to receiving your contribution! :smiley: \ No newline at end of file diff --git a/.github/workflows/benchmark.yml b/.github/workflows/benchmark.yml deleted file mode 100644 index e4f10fe..0000000 --- a/.github/workflows/benchmark.yml +++ /dev/null @@ -1,64 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: benchmark - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to run benchmarks: - benchmark: - - # Define a display name: - name: 'Run benchmarks' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Run benchmarks: - - name: 'Run benchmarks' - run: | - npm run benchmark diff --git a/.github/workflows/cancel.yml b/.github/workflows/cancel.yml deleted file mode 100644 index b5291db..0000000 --- a/.github/workflows/cancel.yml +++ /dev/null @@ -1,57 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2021 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: cancel - -# Workflow triggers: -on: - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job to cancel existing workflow runs: - cancel: - - # Define a display name: - name: 'Cancel workflow runs' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Time limit: - timeout-minutes: 3 - - # Define the sequence of job steps... - steps: - - # Cancel existing workflow runs: - - name: 'Cancel existing workflow runs' - # Pin action to full length commit SHA - uses: styfle/cancel-workflow-action@85880fa0301c86cca9da44039ee3bb12d3bedbfa # v0.12.1 - with: - workflow_id: >- - benchmark.yml, - examples.yml, - test.yml, - test_coverage.yml, - test_install.yml, - publish.yml - access_token: ${{ github.token }} diff --git a/.github/workflows/close_pull_requests.yml b/.github/workflows/close_pull_requests.yml deleted file mode 100644 index 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -252,7 +249,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. @@ -317,7 +314,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/array-base-flatten5d +[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/array-base-flatten5d/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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7fc978..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param value - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7f94efa --- /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 r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 579c1fa..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); From dd0cb99f603413abdf8b02dd4232daf7aa2b36be Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 01:36:56 +0000 Subject: [PATCH 97/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 24dd9c4..579c1fa 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.2.2", @@ -92,4 +93,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 81e926b89eab2a39f237b5a84b520baf42b3e0dd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 02:10:28 +0000 Subject: [PATCH 98/99] Remove files --- index.d.ts | 193 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5040 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 0550877..0000000 --- a/index.d.ts +++ /dev/null @@ -1,193 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Collection, Array5D } from '@stdlib/types/array'; -import { Shape5D } from '@stdlib/types/ndarray'; - -/** -* Nullary callback function. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Unary callback function. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Binary callback function. -* -* @param value - array element -* @param indices - element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Array ) => U; - -/** -* Ternary callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Array, arr: Array5D ) => U; - -/** -* Callback function. -* -* @param value - array element -* @param indices - element indices -* @param arr - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing `flatten5dBy`. -*/ -interface Flatten5dBy { - /** - * Flattens a five-dimensional nested array according to a callback function. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns flattened array - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: Array5D, shape: Shape5D, colexicographic: boolean, clbk: Callback, thisArg?: ThisParameterType> ): Array; - - /** - * Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. - * - * ## Notes - * - * - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). - * - * @param x - input array - * @param shape - array shape - * @param colexicographic - specifies whether to flatten array values in colexicographic order - * @param out - output array - * @param stride - output array stride - * @param offset - output array index offset - * @param clbk - callback function - * @param thisArg - callback execution context - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * function scale( v ) { - * return v * 2; - * } - * - * var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - * - * var out = flatten5dBy.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: Array5D, shape: Shape5D, colexicographic: boolean, out: Collection, stride: number, offset: number, clbk: Callback, thisArg?: ThisParameterType> ): Collection; -} - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param x - input array -* @param shape - array shape -* @param colexicographic - specifies whether to flatten array values in colexicographic order -* @param clbk - callback function -* @param thisArg - callback execution context -* @returns flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten5dBy: Flatten5dBy; - - -// EXPORTS // - -export = flatten5dBy; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 7f94efa..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 r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 3056be6..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7a93ac2e4d289415dcbbcc194daae810252afdc3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 24 Feb 2025 02:10:44 +0000 Subject: [PATCH 99/99] 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 | 186 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 49 +- SECURITY.md | 5 - benchmark/benchmark.js | 143 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 106 - docs/types/test.ts | 340 -- examples/index.js | 85 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 129 - lib/index.js | 82 - lib/main.js | 122 - package.json | 63 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 455 -- test/test.js | 40 - test/test.main.js | 310 -- 47 files changed, 4874 insertions(+), 5480 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 (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 30784f2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-02-24T01:24:36.526Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 59b42b5..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/array/base/flatten5d-by) 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 0a4b026..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/array/base/flatten5d-by) 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 f504e98..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: '5 17 * * 0' - - # 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 + + ```
@@ -252,7 +249,7 @@ out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); ## 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]. @@ -317,7 +314,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/array-base-flatten5d +[@stdlib/array/base/flatten5d]: https://github.com/stdlib-js/array-base-flatten5d/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 e3d6143..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,143 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 isArray = require( '@stdlib/assert-is-array' ); -var isFloat64Array = require( '@stdlib/assert-is-float64array' ); -var zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var Float64Array = require( '@stdlib/array-float64' ); -var pkg = require( './../package.json' ).name; -var flatten5dBy = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Scales an input value. -* -* @private -* @param {number} v - input value -* @returns {number} output value -* -* @example -* var v = scale( 2.0 ); -* // returns 4.0 -*/ -function scale( v ) { - return v * 2.0; -} - - -// MAIN // - -bench( pkg+':size=108,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], false, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':size=108,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy( x, [ 2, 2, 3, 3, 3 ], true, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return an array' ); - } - } - b.toc(); - if ( !isArray( v ) ) { - b.fail( 'should return an array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); - -bench( pkg+':assign:size=108,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 108 ); - x = filled( filled( filled( filled( zeroTo( 3 ), 3 ), 3 ), 2 ), 2 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten5dBy.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0, scale ); - if ( typeof v !== 'object' ) { - b.fail( 'should return a Float64Array' ); - } - } - b.toc(); - if ( !isFloat64Array( v ) ) { - b.fail( 'should return a Float64Array' ); - } - b.pass( 'benchmark finished' ); - b.end(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 1ea0e89..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/array/base/flatten5d-by" -%% click B href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten5d-by -[production-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten5d-by/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten5d-by/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 3fed7fa..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten5dBy from '../docs/types/index'; -export = flatten5dBy; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 04b4801..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var w=function(u,f){return function(){return f||u((f={exports:{}}).exports,f),f.exports}};var C=w(function(L,z){ -function G(u,f,R,e,d){var S,q,y,l,c,s,o,i,r,a,v,t,n,B,m;if(q=f[4],y=f[3],l=f[2],c=f[1],s=f[0],S=[],R){for(o=0;o>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten5dBy;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' );\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nvar setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' );\nvar main = require( './main.js' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nmodule.exports = main;\n"], - "mappings": "uGAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA0DA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,EAAU,CAChE,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,CAAE,EACdM,EAAKN,EAAO,CAAE,EACdO,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EAGdI,EAAM,CAAC,EAGFH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAI,KAAMF,EAAK,KAAMC,EAASJ,EAAGe,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMhG,OAAOK,CACR,CACA,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAI,KAAMF,EAAK,KAAMC,EAASY,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGX,CAAE,CAAE,EAMzE,OAAOK,CACR,CAKAP,EAAO,QAAUC,ICzHjB,IAAAqB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAiEA,SAASC,EAAaC,EAAGC,EAAOC,EAAiBC,EAAKC,EAAQC,EAAQC,EAAMC,EAAU,CACrF,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAWJ,GARAd,EAAKP,EAAO,CAAE,EACdQ,EAAKR,EAAO,CAAE,EACdS,EAAKT,EAAO,CAAE,EACdU,EAAKV,EAAO,CAAE,EACdW,EAAKX,EAAO,CAAE,EAGdqB,EAAKjB,EACAH,EAAkB,CACtB,IAAMW,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBd,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASP,EAAGiB,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAGD,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EAC3FsB,GAAMlB,EAMX,OAAOD,CACR,CACA,IAAMc,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKrB,EAAGiB,CAAG,EACLD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,CAAG,EAAIhB,EAAK,KAAMC,EAASW,EAAIL,CAAG,EAAG,CAAEI,EAAID,EAAID,EAAID,EAAID,CAAG,EAAGb,CAAE,EACpEsB,GAAMlB,EAMX,OAAOD,CACR,CAKAL,EAAO,QAAUC,IC3DjB,IAAIwB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "clbk", "thisArg", "out", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "require_assign", "__commonJSMin", "exports", "module", "flatten5dBy", "x", "shape", "colexicographic", "out", "stride", "offset", "clbk", "thisArg", "S0", "S1", "S2", "S3", "S4", "i0", "i1", "i2", "i3", "i4", "a0", "a1", "a2", "a3", "io", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 7b7b08c..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,106 +0,0 @@ - -{{alias}}( x, shape, colex, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: ArrayLikeObject - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], false, fcn ) - [ 2, 4, 6, 8 ] - > out = {{alias}}( x, [ 2, 1, 1, 1, 2 ], true, fcn ) - [ 2, 6, 4, 8 ] - - -{{alias}}.assign( x, shape, colex, out, stride, offset, clbk[, thisArg] ) - Flattens a five-dimensional nested array according to a callback function - and assigns elements to a provided output array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - The callback function is provided the following arguments: - - - value: nested array element. - - indices: element indices (in lexicographic order). - - arr: the input array. - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colex: boolean - Specifies whether to flatten array values in colexicographic order. - - out: Collection - Output array. - - stride: integer - Output array stride. - - offset: integer - Output array index offset. - - clbk: Function - Callback function. - - thisArg: any (optional) - Callback execution context. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > function fcn( v ) { return v * 2; }; - > var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, fcn ) - [ 2, 4, 6, 8 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, fcn ); - > out - [ 2, 6, 4, 8 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d7fc978..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,340 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten5dBy = require( './index' ); - -/** -* Identity function. -* -* @param value - input value -* @returns input value -*/ -function identity( value: T ): T { - return value; -} - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType number[] - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType number[] - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType number[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity ); // $ExpectType string[] - - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectType string[] - flatten5dBy( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, identity, {} ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity ); // $ExpectError - - flatten5dBy( 1, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( true, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( false, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( null, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( void 0, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError - flatten5dBy( {}, [ 2, 1, 1, 1, 2 ], false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, '', false, identity ); // $ExpectError - flatten5dBy( x, 1, false, identity ); // $ExpectError - flatten5dBy( x, true, false, identity ); // $ExpectError - flatten5dBy( x, false, false, identity ); // $ExpectError - flatten5dBy( x, null, false, identity ); // $ExpectError - flatten5dBy( x, void 0, false, identity ); // $ExpectError - flatten5dBy( x, {}, false, identity ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity ); // $ExpectError - - flatten5dBy( x, '', false, identity, {} ); // $ExpectError - flatten5dBy( x, 1, false, identity, {} ); // $ExpectError - flatten5dBy( x, true, false, identity, {} ); // $ExpectError - flatten5dBy( x, false, false, identity, {} ); // $ExpectError - flatten5dBy( x, null, false, identity, {} ); // $ExpectError - flatten5dBy( x, void 0, false, identity, {} ); // $ExpectError - flatten5dBy( x, {}, false, identity, {} ); // $ExpectError - flatten5dBy( x, [ 1, '2', 3 ], false, identity, {} ); // $ExpectError - flatten5dBy( x, ( x: number ): number => x, false, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], '', identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], 1, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], null, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], void 0, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], {}, identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], [], identity, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a fourth argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '' ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0 ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [] ); // $ExpectError - - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, '', {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, 1, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, true, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, false, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, null, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, void 0, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, {}, {} ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, [], {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy(); // $ExpectError - flatten5dBy( x ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, identity, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a collection... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - const out1 = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out1, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out1, 1, 0, identity, {} ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity ); // $ExpectType Collection - - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], false, out2, 1, 0, identity, {} ); // $ExpectType Collection - flatten5dBy.assign( [ [ [ [ [ '1', '2' ] ] ] ], [ [ [ [ '3', '4' ] ] ] ] ], [ 2, 1, 1, 1, 2 ], true, out2, 1, 0, identity, {} ); // $ExpectType Collection -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not an array-like object... -{ - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( 1, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( true, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( false, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( null, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( void 0, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( {}, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not an array-like object containing numbers... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, '', false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, '', false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, 1, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, true, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, false, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, null, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, void 0, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, {}, false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 1, '2', 3 ], false, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, ( x: number ): number => x, false, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not a boolean... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], '', out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], 1, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], null, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], void 0, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], {}, out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], [], out, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], ( x: number ): number => x, out, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not an array-like object... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, 1, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, true, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, false, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, null, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, void 0, 1, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, {}, 1, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fifth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, '1', 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, true, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, false, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, null, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, void 0, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, {}, 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, [], 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, ( x: number ): number => x, 0, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a sixth argument which is not a number... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, '1', identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, true, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, false, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, null, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, void 0, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, {}, identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, [], identity, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, ( x: number ): number => x, identity, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a seventh argument which is not a function... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1' ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [] ); // $ExpectError - - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, '1', {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, 1, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, true, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, false, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, null, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, void 0, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, {}, {} ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, [], {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; - const out = [ 0, 0, 0, 0 ]; - - flatten5dBy.assign(); // $ExpectError - flatten5dBy.assign( x ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ] ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0 ); // $ExpectError - flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], false, out, 1, 0, identity, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 26ceb39..0000000 --- a/examples/index.js +++ /dev/null @@ -1,85 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib' ); - -var fcn = naryFunction( abs, 1 ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ -1, -2 ], [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], [ -15, -16 ] - ] - ] - ] -]; - -var out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, fcn ); -console.log( out ); -// => [] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, fcn ); -console.log( out ); -// => [ 1 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn ); -console.log( out ); -// => [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] diff --git a/docs/types/index.d.ts b/index.d.ts similarity index 98% rename from docs/types/index.d.ts rename to index.d.ts index ca040d2..0550877 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array5D } from '@stdlib/types/array'; import { Shape5D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..7f94efa --- /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 r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function o(r,o,f,n,e){var s,t,l,a,i,u,c,d,p,m,h,v,g,j,b;if(t=o[4],l=o[3],a=o[2],i=o[1],u=o[0],s=[],f){for(c=0;c>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Array} flattened array\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, clbk, thisArg ) {\n\tvar out;\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Initialize an output array:\n\tout = [];\n\n\t// Iterate over the array dimensions...\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n/* eslint-disable max-depth, max-len */\n\n'use strict';\n\n// MAIN //\n\n/**\n* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array.\n*\n* ## Notes\n*\n* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array).\n*\n* @param {Array>>>} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order\n* @param {Collection} out - output array\n* @param {integer} stride - output array stride\n* @param {NonNegativeInteger} offset - output array index offset\n* @param {Function} clbk - callback function\n* @param {*} [thisArg] - callback execution context\n* @returns {Collection} output array\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*/\nfunction flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar S3;\n\tvar S4;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar i3;\n\tvar i4;\n\tvar a0;\n\tvar a1;\n\tvar a2;\n\tvar a3;\n\tvar io;\n\n\t// Extract loop variables:\n\tS0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices\n\tS1 = shape[ 3 ];\n\tS2 = shape[ 2 ];\n\tS3 = shape[ 1 ];\n\tS4 = shape[ 0 ];\n\n\t// Iterate over the array dimensions...\n\tio = offset;\n\tif ( colexicographic ) {\n\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\t\t\t\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order\n\t\t\t\t\t\t\tio += stride;\n\t\t\t\t\t\t}\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t\treturn out;\n\t}\n\tfor ( i4 = 0; i4 < S4; i4++ ) {\n\t\ta3 = x[ i4 ];\n\t\tfor ( i3 = 0; i3 < S3; i3++ ) {\n\t\t\ta2 = a3[ i3 ];\n\t\t\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\t\t\ta1 = a2[ i2 ];\n\t\t\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\t\t\ta0 = a1[ i1 ];\n\t\t\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\t\t\tout[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order\n\t\t\t\t\t\tio += stride;\n\t\t\t\t\t}\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten5dBy;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n/**\n* Flatten a five-dimensional nested array according to a callback function.\n*\n* @module @stdlib/array-base-flatten5d-by\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale );\n* // returns [ 2, 4, 6, 8 ]\n*\n* @example\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten5dBy from '@stdlib/array-base-flatten5d-by';\n*\n* function scale( v ) {\n* return v * 2;\n* }\n*\n* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale );\n* // returns [ 2, 6, 4, 8 ]\n*\n* var bool = ( y === out );\n* // returns true\n*/\n\n// MODULES //\n\nimport setReadOnly from '@stdlib/utils-define-nonenumerable-read-only-property';\nimport main from './main.js';\nimport assign from './assign.js';\n\n\n// MAIN //\n\nsetReadOnly( main, 'assign', assign );\n\n\n// EXPORTS //\n\nexport default main;\n"],"names":["flatten5dBy","x","shape","colexicographic","clbk","thisArg","out","S0","S1","S2","S3","S4","i0","i1","i2","i3","i4","a0","a1","a2","a3","push","call","stride","offset","io","setReadOnly","main","assign"],"mappings":";;wHA0DA,SAASA,EAAaC,EAAGC,EAAOC,EAAiBC,EAAMC,GACtD,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAaJ,GAVAb,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZI,EAAM,GAGDH,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAM5F,OAAOK,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAIe,KAAMjB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,IAMrE,OAAOK,CACR,CCnDA,SAASN,EAAaC,EAAGC,EAAOC,EAAiBG,EAAKiB,EAAQC,EAAQpB,EAAMC,GAC3E,IAAIE,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAK,EAWJ,GARAlB,EAAKL,EAAO,GACZM,EAAKN,EAAO,GACZO,EAAKP,EAAO,GACZQ,EAAKR,EAAO,GACZS,EAAKT,EAAO,GAGZuB,EAAKD,EACArB,EAAkB,CACtB,IAAMS,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtB,IAAMC,EAAK,EAAGA,EAAKL,EAAIK,IACtBV,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASJ,EAAGe,GAAMD,GAAMD,GAAMD,GAAMD,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GACzFwB,GAAMF,EAMX,OAAOjB,CACP,CACD,IAAMU,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKnB,EAAGe,GACFD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IAEtB,IADAI,EAAKC,EAAIL,GACHD,EAAK,EAAGA,EAAKL,EAAIK,IACtBN,EAAKmB,GAAOrB,EAAKkB,KAAMjB,EAASY,EAAIL,GAAM,CAAEI,EAAID,EAAID,EAAID,EAAID,GAAMX,GAClEwB,GAAMF,EAMX,OAAOjB,CACR,CC/CAoB,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1f67973..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,129 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function and assigns elements to a provided output array. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array index offset -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, new Float64Array( 4 ), 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, out, stride, offset, clbk, thisArg ) { - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - var io; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Iterate over the array dimensions... - io = offset; - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out[ io ] = clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in column-major (Fortran-style) order - io += stride; - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out[ io ] = clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ); // equivalent to storing in row-major (C-style) order - io += stride; - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index 7b7030d..0000000 --- a/lib/index.js +++ /dev/null @@ -1,82 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Flatten a five-dimensional nested array according to a callback function. -* -* @module @stdlib/array-base-flatten5d-by -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten5dBy = require( '@stdlib/array-base-flatten5d-by' ); -* -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten5dBy.assign( x, [ 2, 1, 1, 1, 2 ], true, out, 1, 0, scale ); -* // returns [ 2, 6, 4, 8 ] -* -* var bool = ( y === out ); -* // returns true -*/ - -// MODULES // - -var setReadOnly = require( '@stdlib/utils-define-nonenumerable-read-only-property' ); -var main = require( './main.js' ); -var assign = require( './assign.js' ); - - -// MAIN // - -setReadOnly( main, 'assign', assign ); - - -// EXPORTS // - -module.exports = main; diff --git a/lib/main.js b/lib/main.js deleted file mode 100644 index 6e857b8..0000000 --- a/lib/main.js +++ /dev/null @@ -1,122 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -/* eslint-disable max-depth, max-len */ - -'use strict'; - -// MAIN // - -/** -* Flattens a five-dimensional nested array according to a callback function. -* -* ## Notes -* -* - The function assumes that all nested arrays have the same length (i.e., the input array is **not** a ragged array). -* -* @param {Array>>>} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {boolean} colexicographic - specifies whether to flatten array values in colexicographic order -* @param {Function} clbk - callback function -* @param {*} [thisArg] - callback execution context -* @returns {Array} flattened array -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], false, scale ); -* // returns [ 2, 4, 6, 8 ] -* -* @example -* function scale( v ) { -* return v * 2; -* } -* -* var x = [ [ [ [ [ 1, 2 ] ] ] ], [ [ [ [ 3, 4 ] ] ] ] ]; -* -* var out = flatten5dBy( x, [ 2, 1, 1, 1, 2 ], true, scale ); -* // returns [ 2, 6, 4, 8 ] -*/ -function flatten5dBy( x, shape, colexicographic, clbk, thisArg ) { - var out; - var S0; - var S1; - var S2; - var S3; - var S4; - var i0; - var i1; - var i2; - var i3; - var i4; - var a0; - var a1; - var a2; - var a3; - - // Extract loop variables: - S0 = shape[ 4 ]; // for nested arrays, the last dimensions have the fastest changing indices - S1 = shape[ 3 ]; - S2 = shape[ 2 ]; - S3 = shape[ 1 ]; - S4 = shape[ 0 ]; - - // Initialize an output array: - out = []; - - // Iterate over the array dimensions... - if ( colexicographic ) { - for ( i0 = 0; i0 < S0; i0++ ) { - for ( i1 = 0; i1 < S1; i1++ ) { - for ( i2 = 0; i2 < S2; i2++ ) { - for ( i3 = 0; i3 < S3; i3++ ) { - for ( i4 = 0; i4 < S4; i4++ ) { - out.push( clbk.call( thisArg, x[ i4 ][ i3 ][ i2 ][ i1 ][ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in column-major (Fortran-style) order - } - } - } - } - } - return out; - } - for ( i4 = 0; i4 < S4; i4++ ) { - a3 = x[ i4 ]; - for ( i3 = 0; i3 < S3; i3++ ) { - a2 = a3[ i3 ]; - for ( i2 = 0; i2 < S2; i2++ ) { - a1 = a2[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - a0 = a1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - out.push( clbk.call( thisArg, a0[ i0 ], [ i4, i3, i2, i1, i0 ], x ) ); // equivalent to storing in row-major (C-style) order - } - } - } - } - } - return out; -} - - -// EXPORTS // - -module.exports = flatten5dBy; diff --git a/package.json b/package.json index 579c1fa..6b8006f 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Flatten a five-dimensional nested array according to a callback function.", "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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled": "^0.2.2", - "@stdlib/array-base-zero-to": "^0.2.1", - "@stdlib/array-float64": "^0.2.2", - "@stdlib/assert-has-own-property": "^0.2.2", - "@stdlib/assert-is-array": "^0.2.2", - "@stdlib/assert-is-float64array": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/utils-nary-function": "^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", "utilities", @@ -93,4 +36,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..3056be6 --- /dev/null +++ b/stats.html @@ -0,0 +1,4842 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/dist/test.js b/test/dist/test.js deleted file mode 100644 index a8a9c60..0000000 --- a/test/dist/test.js +++ /dev/null @@ -1,33 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var tape = require( 'tape' ); -var main = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is defined', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( main !== void 0, true, 'main export is defined' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index ad379b8..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,455 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var Float64Array = require( '@stdlib/array-float64' ); -var flatten5dBy = require( './../lib/assign.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 2, 0, 3, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing a stride (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 1, 0, 3, 0, 2, 0, 4, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 2, 0, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 2, 3, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports providing an offset (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 0, 1, 3, 2, 4, 0, 0 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 2, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (lexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 3, 0, 2, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports complex access patterns (colexicographic)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - expected = new Float64Array( [ 0, 4, 0, 2, 0, 3, 0, 1 ] ); - out = new Float64Array( 8 ); - actual = flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, -2, 7, clbk ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], false, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var out; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - out = new Float64Array( 4 ); - flatten5dBy( x, [ 1, 1, 1, 2, 2 ], true, out, 1, 0, fcn, ctx ); - t.strictEqual( ctx.count, 4, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 39b13b2..0000000 --- a/test/test.js +++ /dev/null @@ -1,40 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 hasOwnProp = require( '@stdlib/assert-has-own-property' ); -var flatten5dBy = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten5dBy, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten5dBy.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index dc02d78..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,310 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var flatten5dBy = require( './../lib/main.js' ); - - -// VARIABLES // - -var clbk = naryFunction( abs, 1 ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten5dBy, 'function', 'main export is a function', clbk ); - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic)', function test( t ) { - var expected; - var actual; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 0, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 0, 0, 1, 0, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten5dBy( x, [ 1, 0, 0, 1, 0 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten5dBy( x, [ 1, 1, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten5dBy( x, [ 2, 1, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten5dBy( x, [ 1, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 1 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 1, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 3, 11, 7, 15, 2, 10, 6, 14, 4, 12, 8, 16 ]; - actual = flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, clbk ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function supports setting the callback execution context (lexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], false, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -}); - -tape( 'the function supports setting the callback execution context (colexicographic)', function test( t ) { - var ctx; - var x; - - x = [ - [ - [ - [ - [ -1, -2 ], - [ -3, -4 ] - ] - ], - [ - [ - [ -5, -6 ], - [ -7, -8 ] - ] - ] - ], - [ - [ - [ - [ -9, -10 ], - [ -11, -12 ] - ] - ], - [ - [ - [ -13, -14 ], - [ -15, -16 ] - ] - ] - ] - ]; - - ctx = { - 'count': 0 - }; - - flatten5dBy( x, [ 2, 2, 1, 2, 2 ], true, fcn, ctx ); - t.strictEqual( ctx.count, 16, 'returns expected value' ); - - t.end(); - - function fcn( value, indices, arr ) { - this.count += 1; // eslint-disable-line no-invalid-this - t.strictEqual( indices.length, 5, 'returns expected value' ); - t.strictEqual( value, arr[ indices[0] ][ indices[1] ][ indices[2] ][ indices[3] ][ indices[4] ], 'returns expected value' ); - t.strictEqual( arr, x, 'returns expected value' ); - } -});