From 9ef726d21c588138dd303b04f9a18e540d17e790 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 21 Jul 2023 22:13:30 +0000 Subject: [PATCH 01/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 0101c4e..2b8daa3 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,8 @@ "@stdlib/ndarray-base-numel": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", "@stdlib/ndarray-base-vind2bind": "^0.0.8", - "@stdlib/types": "^0.0.14" + "@stdlib/types": "^0.0.14", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -85,4 +86,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From c3380101800a24686e6641d0b13e998920d6c525 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 21 Jul 2023 22:14:50 +0000 Subject: [PATCH 02/67] 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 | 33 +- benchmark/benchmark.js | 207 - branches.md | 53 - docs/repl.txt | 34 - docs/types/test.ts | 81 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 50 - lib/main.js | 184 - package.json | 61 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 669 --- 36 files changed, 6199 insertions(+), 4519 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 (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 d474de7..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/flatten) 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 e5f11c0..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/flatten) 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 da0eb8d..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: '43 19 * * 4' - - # 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 3e8e2db..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@v1 - 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 + + ```
@@ -167,7 +160,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 c86d726..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,207 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var pkg = require( './../package.json' ).name; -var flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 757066e..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,34 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0965631..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,81 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 96% rename from docs/types/index.d.ts rename to index.d.ts index 9397b57..99710dc 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..166cba9 --- /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/ndarray-base-shape2strides@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function n(r,s,t){var e;for(e=0;e=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -86,4 +31,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..69c10af --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2dc3436..0000000 --- a/test/test.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From cc90854f304c465b1c1ae9b93a7f95b9752497a2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 23 Jul 2023 20:01:07 +0000 Subject: [PATCH 03/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 0101c4e..2b8daa3 100644 --- a/package.json +++ b/package.json @@ -41,7 +41,8 @@ "@stdlib/ndarray-base-numel": "^0.0.8", "@stdlib/ndarray-base-shape2strides": "^0.0.8", "@stdlib/ndarray-base-vind2bind": "^0.0.8", - "@stdlib/types": "^0.0.14" + "@stdlib/types": "^0.0.14", + "@stdlib/error-tools-fmtprodmsg": "^0.0.2" }, "devDependencies": { "@stdlib/array-base-filled": "^0.0.2", @@ -85,4 +86,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a336bcd97ad3e5163f69ddcad9740d2a41735fd5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 23 Jul 2023 20:01:37 +0000 Subject: [PATCH 04/67] Remove files --- index.d.ts | 109 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6291 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 99710dc..0000000 --- a/index.d.ts +++ /dev/null @@ -1,109 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* One-dimensional array. -*/ -type Array1D = Collection; - -/** -* Two-dimensional array. -*/ -type Array2D = Array>; - -/** -* Three-dimensional array. -*/ -type Array3D = Array>; - -/** -* Four-dimensional array. -*/ -type Array4D = Array>; - -/** -* Five-dimensional array. -*/ -type Array5D = Array>; - -/** -* Six-dimensional array. -*/ -type Array6D = Array>; - -/** -* Seven-dimensional array. -*/ -type Array7D = Array>; - -/** -* Eight-dimensional array. -*/ -type Array8D = Array>; - -/** -* Nine-dimensional array. -*/ -type Array9D = Array>; - -/** -* Ten-dimensional array. -*/ -type Array10D = Array>; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare function flatten( x: ArrayND, shape: Collection, colexicographic: boolean ): Array; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 166cba9..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/ndarray-base-shape2strides@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function n(r,s,t){var e;for(e=0;e - - - - - - Rollup Visualizer - - - -
- - - - - From 3cf0d93b5503977d89e4250a5b5d12d6e08d8c0a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 23 Jul 2023 20:02:26 +0000 Subject: [PATCH 05/67] 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 | 33 +- benchmark/benchmark.js | 207 - branches.md | 53 - docs/repl.txt | 34 - docs/types/test.ts | 81 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/index.js | 50 - lib/main.js | 186 - package.json | 61 +- stats.html | 6177 +++++++++++++++++++++ test/test.js | 669 --- 36 files changed, 6199 insertions(+), 4521 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 (96%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/test.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 d474de7..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/flatten) 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 e5f11c0..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/flatten) 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 da0eb8d..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: '43 19 * * 4' - - # 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 3e8e2db..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@v1 - 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 + + ```
@@ -167,7 +160,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 c86d726..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,207 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 zeroTo = require( '@stdlib/array-base-zero-to' ); -var filled = require( '@stdlib/array-base-filled' ); -var pkg = require( './../package.json' ).name; -var flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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(); -}); diff --git a/branches.md b/branches.md deleted file mode 100644 index 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 757066e..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,34 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0965631..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,81 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 96% rename from docs/types/index.d.ts rename to index.d.ts index 9397b57..99710dc 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..166cba9 --- /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/ndarray-base-shape2strides@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function n(r,s,t){var e;for(e=0;e=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "utilities", @@ -86,4 +31,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..fcd425a --- /dev/null +++ b/stats.html @@ -0,0 +1,6177 @@ + + + + + + + + Rollup Visualizer + + + +
+ + + + + diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 2dc3436..0000000 --- a/test/test.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 0efcb83723ebcfb2390bdd7c330d256d69006f29 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 27 Jul 2023 04:25:40 +0000 Subject: [PATCH 06/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index cc5e4f1..63e32d0 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.0.8", "@stdlib/ndarray-base-vind2bind": "^0.0.8", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From efbe16d131463e1b7a80299010b53e053b92644e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 27 Jul 2023 04:26:12 +0000 Subject: [PATCH 07/67] Remove files --- index.d.ts | 109 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6291 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 99710dc..0000000 --- a/index.d.ts +++ /dev/null @@ -1,109 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* One-dimensional array. -*/ -type Array1D = Collection; - -/** -* Two-dimensional array. -*/ -type Array2D = Array>; - -/** -* Three-dimensional array. -*/ -type Array3D = Array>; - -/** -* Four-dimensional array. -*/ -type Array4D = Array>; - -/** -* Five-dimensional array. -*/ -type Array5D = Array>; - -/** -* Six-dimensional array. -*/ -type Array6D = Array>; - -/** -* Seven-dimensional array. -*/ -type Array7D = Array>; - -/** -* Eight-dimensional array. -*/ -type Array8D = Array>; - -/** -* Nine-dimensional array. -*/ -type Array9D = Array>; - -/** -* Ten-dimensional array. -*/ -type Array10D = Array>; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare function flatten( x: ArrayND, shape: Collection, colexicographic: boolean ): Array; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 166cba9..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/ndarray-base-shape2strides@esm/index.mjs";import s from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function n(r,s,t){var e;for(e=0;e - - - - - - Rollup Visualizer - - - -
- - - - - From 90a79bb4fb21040c9c9bfee9c8f274ab141d4427 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 27 Jul 2023 04:26:55 +0000 Subject: [PATCH 08/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 39 files changed, 6206 insertions(+), 5917 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 d474de7..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/flatten) 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 e5f11c0..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/flatten) 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 da0eb8d..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: '43 19 * * 4' - - # 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 + + ```
@@ -187,7 +186,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 946f4d6..9ad1341 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..acb7c21 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;ijBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 63e32d0..336c054 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.0.2", - "@stdlib/blas-ext-base-grev": "^0.0.10", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/ndarray-base-vind2bind": "^0.0.8", - "@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", - "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", @@ -91,4 +31,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..7b9eb4d --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From be787f297575c781fb82fe72fc9c773021f93741 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 14:01:54 +0000 Subject: [PATCH 09/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index d101f9b..01e284e 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.0.8", "@stdlib/ndarray-base-vind2bind": "^0.0.8", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 40ce6b6d8af4810d45d08c98fd13ad25b7b62456 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 14:02:55 +0000 Subject: [PATCH 10/67] Remove files --- index.d.ts | 173 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6355 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 9ad1341..0000000 --- a/index.d.ts +++ /dev/null @@ -1,173 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* One-dimensional array. -*/ -type Array1D = Collection; - -/** -* Two-dimensional array. -*/ -type Array2D = Array>; - -/** -* Three-dimensional array. -*/ -type Array3D = Array>; - -/** -* Four-dimensional array. -*/ -type Array4D = Array>; - -/** -* Five-dimensional array. -*/ -type Array5D = Array>; - -/** -* Six-dimensional array. -*/ -type Array6D = Array>; - -/** -* Seven-dimensional array. -*/ -type Array7D = Array>; - -/** -* Eight-dimensional array. -*/ -type Array8D = Array>; - -/** -* Nine-dimensional array. -*/ -type Array9D = Array>; - -/** -* Ten-dimensional array. -*/ -type Array10D = Array>; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Collection, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Collection, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index acb7c21..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;ijBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7b9eb4d..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 94ff55e26045ae2015723636a87bce3745f0e9b4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 14:03:45 +0000 Subject: [PATCH 11/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 39 files changed, 6206 insertions(+), 5917 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 d474de7..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/flatten) 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 e5f11c0..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/flatten) 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 da0eb8d..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: '43 19 * * 4' - - # 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 + + ```
@@ -187,7 +186,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm \ No newline at end of file diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 946f4d6..9ad1341 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..acb7c21 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;ijBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 01e284e..827ec7d 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.0.2", - "@stdlib/blas-ext-base-grev": "^0.0.10", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/ndarray-base-vind2bind": "^0.0.8", - "@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", - "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", @@ -91,4 +31,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..5affc35 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From ad0106875516345c25b031404865fc008fdba407 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 31 Jul 2023 14:04:02 +0000 Subject: [PATCH 12/67] 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 2179717..f7484e4 100644 --- a/README.md +++ b/README.md @@ -31,13 +31,13 @@ limitations under the License. ## Usage ```javascript -import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@esm/index.mjs'; +import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@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-flatten@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@v0.0.1-esm/index.mjs'; ``` #### flatten( x, shape, colexicographic ) @@ -106,7 +106,7 @@ y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); - - - - From 68de43d0493172dadef305476545031d90a6eedf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 17 Aug 2023 02:25:45 +0000 Subject: [PATCH 16/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 42 files changed, 6206 insertions(+), 5919 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 d474de7..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/flatten) 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 e5f11c0..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/flatten) 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 da0eb8d..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: '43 19 * * 4' - - # 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 + + ```
@@ -187,7 +186,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 df35ac0..bfc8e1e 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..acb7c21 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;ijBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 01e284e..827ec7d 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.0.2", - "@stdlib/blas-ext-base-grev": "^0.0.10", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/ndarray-base-vind2bind": "^0.0.8", - "@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", - "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", @@ -91,4 +31,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..19123d3 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 5216819c9bdd6af9c3fdec28c0792815fc8ba0a3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 20:22:51 +0000 Subject: [PATCH 17/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index d101f9b..01e284e 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.0.8", "@stdlib/ndarray-base-vind2bind": "^0.0.8", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From cae9a7255bad63b2015b28397e9d0d753cabbae6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 20:26:52 +0000 Subject: [PATCH 18/67] Remove files --- index.d.ts | 173 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6355 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 bfc8e1e..0000000 --- a/index.d.ts +++ /dev/null @@ -1,173 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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'; - -/** -* One-dimensional array. -*/ -type Array1D = Collection; - -/** -* Two-dimensional array. -*/ -type Array2D = Array>; - -/** -* Three-dimensional array. -*/ -type Array3D = Array>; - -/** -* Four-dimensional array. -*/ -type Array4D = Array>; - -/** -* Five-dimensional array. -*/ -type Array5D = Array>; - -/** -* Six-dimensional array. -*/ -type Array6D = Array>; - -/** -* Seven-dimensional array. -*/ -type Array7D = Array>; - -/** -* Eight-dimensional array. -*/ -type Array8D = Array>; - -/** -* Nine-dimensional array. -*/ -type Array9D = Array>; - -/** -* Ten-dimensional array. -*/ -type Array10D = Array>; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Collection, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Collection, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index acb7c21..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;ijBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 19123d3..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 2dfe5b790dca31def1e4a2a048419ff1bdad3738 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 24 Aug 2023 20:27:41 +0000 Subject: [PATCH 19/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 42 files changed, 6206 insertions(+), 5919 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 (97%) 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 d474de7..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/flatten) 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 e5f11c0..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/flatten) 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 da0eb8d..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: '43 19 * * 4' - - # 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 + + ```
@@ -187,7 +186,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 3c4faa8..79ac08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..acb7c21 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;ijBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 01e284e..827ec7d 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.0.2", - "@stdlib/blas-ext-base-grev": "^0.0.10", - "@stdlib/ndarray-base-numel": "^0.0.8", - "@stdlib/ndarray-base-shape2strides": "^0.0.8", - "@stdlib/ndarray-base-vind2bind": "^0.0.8", - "@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", - "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", @@ -91,4 +31,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..e1993d4 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 370369eccee600f7e310bf7d2502cd0b8bd07b60 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 18:02:45 +0000 Subject: [PATCH 20/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4723865..0f3d344 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.1.0", "@stdlib/ndarray-base-vind2bind": "^0.1.0", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 13c5c9b1757eef171d1eaae1386698b285c1616d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 18:38:17 +0000 Subject: [PATCH 21/67] Remove files --- index.d.ts | 124 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6306 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 79ac08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index acb7c21..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;ijBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e1993d4..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c36d7b0f2469840c520ff4d96976f294f71ee5d2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 18:39:04 +0000 Subject: [PATCH 22/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 43 files changed, 6206 insertions(+), 5954 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 (97%) 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 d474de7..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/flatten) 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 e5f11c0..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/flatten) 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 da0eb8d..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: '43 19 * * 4' - - # 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 + + ```
@@ -198,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 3c4faa8..79ac08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..3f613e9 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.0-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.0.10-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;6kBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 0f3d344..7fd26d4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.1.0", - "@stdlib/blas-ext-base-grev": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.0", - "@stdlib/ndarray-base-shape2strides": "^0.1.0", - "@stdlib/ndarray-base-vind2bind": "^0.1.0", - "@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", - "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", @@ -91,4 +31,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..4511277 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From f8207d65cb7a261580ea0d5fcf272fcbd4f82731 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 24 Sep 2023 18:59:09 +0000 Subject: [PATCH 23/67] 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 250a046..ae42b9a 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@esm/index.mjs'; +import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@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-flatten@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@v0.1.0-esm/index.mjs'; ``` #### flatten( x, shape, colexicographic ) @@ -117,7 +117,7 @@ y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); - - - - From 342c1c1df7ff55af3da7fcffca5bf187e0073638 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 3 Oct 2023 02:57:13 +0000 Subject: [PATCH 27/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 40 - test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 6206 insertions(+), 6053 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 (97%) 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 84c8917..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-10-01T05:44:05.630Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1c6de2e..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -198,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 3c4faa8..79ac08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a3851ad --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.0-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 0f23673..7fd26d4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.1.1", - "@stdlib/blas-ext-base-grev": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.0", - "@stdlib/ndarray-base-shape2strides": "^0.1.0", - "@stdlib/ndarray-base-vind2bind": "^0.1.0", - "@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", - "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", @@ -91,4 +31,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..36a6877 --- /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 8ceaf55..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 flatten = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From e4007de46fae78a3a5dd1dba4da36ae7c94d8f85 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 5 Oct 2023 20:37:21 +0000 Subject: [PATCH 28/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 46a31e8..dcfd6a3 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.1.1", "@stdlib/ndarray-base-vind2bind": "^0.1.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From a6704c02d6eeb4094535e783eba44aa11a80500f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 03:55:20 +0000 Subject: [PATCH 29/67] Remove files --- index.d.ts | 124 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6306 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 79ac08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index a3851ad..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.0-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 36a6877..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From bb48d2790c4c33c2760f0eabb997fca974b72e90 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 7 Oct 2023 03:56:00 +0000 Subject: [PATCH 30/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 40 - test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 44 files changed, 6206 insertions(+), 6052 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 (97%) 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 d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1c6de2e..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -198,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 3c4faa8..79ac08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..952eaf7 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index dcfd6a3..7fd26d4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.1.1", - "@stdlib/blas-ext-base-grev": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/ndarray-base-vind2bind": "^0.1.1", - "@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", - "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", @@ -91,4 +31,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..cfb036d --- /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 8ceaf55..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 flatten = require( './../../dist' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.assign.js b/test/test.assign.js deleted file mode 100644 index b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 92627685b2b800737b949a1ad9257eb61acce4d5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 1 Nov 2023 18:23:08 +0000 Subject: [PATCH 31/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b3d41d4..7eb0708 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.1.1", "@stdlib/ndarray-base-vind2bind": "^0.1.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 89e6f32a5aa5d4890776c94831f4473ef1f238a7 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Nov 2023 03:19:42 +0000 Subject: [PATCH 32/67] Remove files --- index.d.ts | 124 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6306 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 79ac08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 952eaf7..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index cfb036d..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 01e3fd80ed19354895dd4c74dd77e9b40fc5bed8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 3 Nov 2023 03:20:27 +0000 Subject: [PATCH 33/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 6206 insertions(+), 6054 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 (97%) 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 a62b5b0..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-11-01T06:05:59.196Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1c6de2e..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -198,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 3c4faa8..79ac08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..952eaf7 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 7eb0708..7fd26d4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.1.1", - "@stdlib/blas-ext-base-grev": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/ndarray-base-vind2bind": "^0.1.1", - "@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", - "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", @@ -91,4 +31,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..1a90e16 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From bbee861c7310d438b4f3263d83a7810c1bba076f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 14:30:38 +0000 Subject: [PATCH 34/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 14a26a5..e1ce17f 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.1.1", "@stdlib/ndarray-base-vind2bind": "^0.1.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From ee6686c8e33791ce34ed6756511322a9cad52132 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:46:08 +0000 Subject: [PATCH 35/67] Remove files --- index.d.ts | 124 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6306 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 79ac08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 952eaf7..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1a90e16..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 0e4e13de4e4f3f0da8528488f874f6526fd0543d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 12:46:43 +0000 Subject: [PATCH 36/67] 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 | 41 +- benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 6206 insertions(+), 6049 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 (97%) 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 8eb5969..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T06:09:44.605Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1c6de2e..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -198,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 2b62eda..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 3c4faa8..79ac08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..952eaf7 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index e1ce17f..7fd26d4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.1.1", - "@stdlib/blas-ext-base-grev": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/ndarray-base-vind2bind": "^0.1.1", - "@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", - "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", @@ -91,4 +31,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..ce70271 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From fef311915db410ec54cb072c739cfffc696995b5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 08:44:23 +0000 Subject: [PATCH 37/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4882d66..792ed33 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.1.1", "@stdlib/ndarray-base-vind2bind": "^0.1.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2c335b398c948df9af1010f4e16dc47899809f4f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:18:11 +0000 Subject: [PATCH 38/67] Remove files --- index.d.ts | 124 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6306 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 79ac08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 952eaf7..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index ce70271..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a2f5e481d3ee8cfac5d57c022620c75924142fe1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 15:18:33 +0000 Subject: [PATCH 39/67] 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 | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 46 files changed, 6206 insertions(+), 6055 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 (97%) 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 7699127..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T05:40:25.344Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d474de7..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/flatten) 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 6213d2a..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/flatten) 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 e4465ed..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -198,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 3c4faa8..79ac08d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..b903df5 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 792ed33..7fd26d4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.1.1", - "@stdlib/blas-ext-base-grev": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/ndarray-base-vind2bind": "^0.1.1", - "@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", - "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", @@ -91,4 +31,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..654528e --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From c4ffcdb6530f494816009af34c3e6b9a58c81bdf Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:10:44 +0000 Subject: [PATCH 40/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4882d66..792ed33 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.1.1", "@stdlib/ndarray-base-vind2bind": "^0.1.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 5e630bfe8a3070891014b2b49bfb275e311e9a23 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:17:05 +0000 Subject: [PATCH 41/67] Remove files --- index.d.ts | 124 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6306 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 79ac08d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( `@stdlib/array/float64` ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index b903df5..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 654528e..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 8768c3d8a5952ba961b018d8f3c4be045898fae9 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:17:19 +0000 Subject: [PATCH 42/67] 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 | 41 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 6206 insertions(+), 6054 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 (97%) 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 d474de7..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/flatten) 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 6213d2a..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/flatten) 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 e4465ed..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -198,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 81b63de..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..b903df5 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 792ed33..7fd26d4 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.1.1", - "@stdlib/blas-ext-base-grev": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/ndarray-base-shape2strides": "^0.1.1", - "@stdlib/ndarray-base-vind2bind": "^0.1.1", - "@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", - "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", @@ -91,4 +31,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..dedce3d --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From d69e533f4c427073859b72cc917ad829dbe9a4c0 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 01:26:52 +0000 Subject: [PATCH 43/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 84d60fb..8fa3d96 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.2.0", "@stdlib/ndarray-base-vind2bind": "^0.2.0", "@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.2.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 1296c3f6387c3fb9f0820385dcad910eed3ef45b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:51:32 +0000 Subject: [PATCH 44/67] Remove files --- index.d.ts | 124 - index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6306 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 f0d5447..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index b903df5..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.1.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.1.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.1.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.1.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index dedce3d..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 32e640e89e8f0a82c9226d1330662ca3ac99fb60 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 04:51:50 +0000 Subject: [PATCH 45/67] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 --- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 6206 insertions(+), 6063 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 (97%) 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 d474de7..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/flatten) 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 6213d2a..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/flatten) 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 e99a970..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -200,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 14a9d67..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..5483970 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.0-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.0-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.0-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.0-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.1.0-esm/index.mjs";function d(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBAuDA,SAASA,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EA9GtB,SA+GTH,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index 8fa3d96..ce648c3 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.2.0", - "@stdlib/blas-ext-base-grev": "^0.2.0", - "@stdlib/ndarray-base-numel": "^0.2.0", - "@stdlib/ndarray-base-shape2strides": "^0.2.0", - "@stdlib/ndarray-base-vind2bind": "^0.2.0", - "@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.2.0", - "@stdlib/array-base-zero-to": "^0.1.0", - "@stdlib/array-float64": "^0.2.0", - "@stdlib/assert-has-own-property": "^0.2.0", - "@stdlib/assert-is-array": "^0.2.0", - "@stdlib/assert-is-float64array": "^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", @@ -91,4 +31,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..e53da1e --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From a3a6db9458263f580b4cee302d69f2bb0a4e87f3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 15 Feb 2024 06:37:41 +0000 Subject: [PATCH 46/67] 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 6097dae..53b90d5 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@esm/index.mjs'; +import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@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-flatten@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@v0.2.0-esm/index.mjs'; ``` #### flatten( x, shape, colexicographic ) @@ -117,7 +117,7 @@ y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); - - - - From 410a96a51434ceddf57526a2058c26a04521d481 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 21:31:26 +0000 Subject: [PATCH 50/67] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 ---- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 4871 insertions(+), 6057 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 (97%) 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 d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1368f05..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -200,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 14a9d67..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..a872a88 --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.0-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index b6c773e..2694041 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.2.1", - "@stdlib/blas-ext-base-grev": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/ndarray-base-vind2bind": "^0.2.1", - "@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.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", - "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", @@ -91,4 +31,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..4f5e9af --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 8216ce760bcd3271d26d4ed0be8113fb1bfc71f6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 22:10:46 +0000 Subject: [PATCH 51/67] 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 ab9c5b6..234b7dd 100644 --- a/README.md +++ b/README.md @@ -42,13 +42,13 @@ limitations under the License. ## Usage ```javascript -import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@esm/index.mjs'; +import flatten from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@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-flatten@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-flatten@v0.2.1-esm/index.mjs'; ``` #### flatten( x, shape, colexicographic ) @@ -117,7 +117,7 @@ y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); - - - - From b1e5aa2f8f3daa408377cf50a50c1865bbcef6a3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 14:13:40 +0000 Subject: [PATCH 55/67] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 ---- test/test.js | 40 - test/test.main.js | 669 --- 46 files changed, 4871 insertions(+), 6059 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 (97%) 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 4dfb5f2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T06:07:51.300Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1368f05..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -200,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 14a9d67..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..357ca6b --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index b3c386a..2694041 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.2.1", - "@stdlib/blas-ext-base-grev": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/ndarray-base-vind2bind": "^0.2.1", - "@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", - "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", @@ -91,4 +31,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..eb054a3 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From f8bc7fc8558e685296c444b07ef78fd9d509f083 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 07:46:05 +0000 Subject: [PATCH 56/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b6541a4..b3c386a 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.2.1", "@stdlib/ndarray-base-vind2bind": "^0.2.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e2452c492668c2136ea0af5b93d3e7375b6cbeee Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:18:09 +0000 Subject: [PATCH 57/67] Remove files --- index.d.ts | 124 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4971 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 f0d5447..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 357ca6b..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index eb054a3..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 3d5f488b9fc9b4289c843c6f46aa1c1e043376e3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 13:18:21 +0000 Subject: [PATCH 58/67] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 ---- test/test.js | 40 - test/test.main.js | 669 --- 46 files changed, 4871 insertions(+), 6062 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 (97%) 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 6f0f3fc..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T05:23:36.644Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1368f05..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -200,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 14a9d67..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..357ca6b --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index b3c386a..2694041 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.2.1", - "@stdlib/blas-ext-base-grev": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/ndarray-base-vind2bind": "^0.2.1", - "@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", - "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", @@ -91,4 +31,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..eb054a3 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From b48286e0a9a90d2c87dfda69f387ef44fd7bd953 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 03:59:33 +0000 Subject: [PATCH 59/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b6541a4..b3c386a 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.2.1", "@stdlib/ndarray-base-vind2bind": "^0.2.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 6c8c9baa48aa0228dca9fcf78cbc4a5b7b6d8e0a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:31:24 +0000 Subject: [PATCH 60/67] Remove files --- index.d.ts | 124 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4971 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 f0d5447..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 357ca6b..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index eb054a3..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From faea998b0343a3622af8908d60b04e2dc06987ad Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 09:31:44 +0000 Subject: [PATCH 61/67] 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 | 43 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 ---- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 4871 insertions(+), 6063 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 (97%) 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 d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1368f05..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -200,7 +197,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 14a9d67..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..357ca6b --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index b3c386a..2694041 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.2.1", - "@stdlib/blas-ext-base-grev": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/ndarray-base-vind2bind": "^0.2.1", - "@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", - "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", @@ -91,4 +31,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..eb054a3 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From ade99cf073d2abe6cec413d679ed10d3c6dc98ec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 May 2024 04:32:15 +0000 Subject: [PATCH 62/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index b6541a4..b3c386a 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.2.1", "@stdlib/ndarray-base-vind2bind": "^0.2.1", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2334bfdd88e912f7d7ddd19cc4afb997a7e30fab Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 May 2024 04:32:44 +0000 Subject: [PATCH 63/67] Remove files --- index.d.ts | 124 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4971 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 f0d5447..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 357ca6b..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index eb054a3..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e527c782ec277c92bea2a935ed624ffb299364bd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 May 2024 04:32:57 +0000 Subject: [PATCH 64/67] 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 | 248 -- .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 | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 ---- test/test.js | 40 - test/test.main.js | 669 --- 45 files changed, 4872 insertions(+), 6071 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 (97%) 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 d474de7..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/flatten) 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 6213d2a..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/flatten) 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 1368f05..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 f92a6c5..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 + + ```
@@ -206,7 +203,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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]. @@ -271,7 +268,7 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/base/flatten-by]: https://github.com/stdlib-js/array-base-flatten-by +[@stdlib/array/base/flatten-by]: https://github.com/stdlib-js/array-base-flatten-by/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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 14a9d67..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..357ca6b --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index b3c386a..2694041 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.2.1", - "@stdlib/blas-ext-base-grev": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/ndarray-base-shape2strides": "^0.2.1", - "@stdlib/ndarray-base-vind2bind": "^0.2.1", - "@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", - "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", @@ -91,4 +31,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..eb054a3 --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); From 2ffd71ee234f1c1a84acf4cef37d6e95234b9918 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:36:47 +0000 Subject: [PATCH 65/67] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 8ecdc45..afd8ac4 100644 --- a/package.json +++ b/package.json @@ -43,7 +43,8 @@ "@stdlib/ndarray-base-shape2strides": "^0.2.2", "@stdlib/ndarray-base-vind2bind": "^0.2.2", "@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", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 33d2cfdbc966e866542d91845f81cc6ac7ec8433 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:44:06 +0000 Subject: [PATCH 66/67] Remove files --- index.d.ts | 124 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 4971 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 f0d5447..0000000 --- a/index.d.ts +++ /dev/null @@ -1,124 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; -import { Shape } from '@stdlib/types/ndarray'; - -/** -* n-dimensional nested array. -*/ -type ArrayND = Array1D | Array2D | Array3D | Array4D | Array5D | Array6D | Array7D | Array8D | Array9D | Array10D; // WARNING: arbitrarily limited to 10 dimensions, which should be fine for most practical purposes - -/** -* Interface describing `flatten`. -*/ -interface Flatten { - /** - * Flattens an n-dimensional nested 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 - * @returns flattened array - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], false ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten( x, [ 2, 2 ], true ); - * // returns [ 1, 3, 2, 4 ] - */ - ( x: ArrayND, shape: Shape, colexicographic: boolean ): Array; - - /** - * Flattens an n-dimensional nested array 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 - * @returns output array - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 2, 3, 4 ] - * - * @example - * var Float64Array = require( '@stdlib/array-float64' ); - * - * var x = [ [ 1, 2 ], [ 3, 4 ] ]; - * - * var out = flatten.assign( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); - * // returns [ 1, 3, 2, 4 ] - */ - assign( x: ArrayND, shape: Shape, colexicographic: boolean, out: Collection, stride: number, offset: number ): Collection; -} - -/** -* Flattens an n-dimensional nested 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 -* @returns flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -declare var flatten: Flatten; - - -// EXPORTS // - -export = flatten; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 357ca6b..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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.1-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.1-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.1-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.1-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index eb054a3..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 908c5cff60f9a89fa72c779d2a0e996550b1f7b8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 10 Mar 2025 00:44:24 +0000 Subject: [PATCH 67/67] 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 | 162 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 45 +- SECURITY.md | 5 - benchmark/benchmark.js | 401 -- branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 80 - docs/types/test.ts | 194 - examples/index.js | 81 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 203 - lib/index.js | 70 - lib/main.js | 62 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 898 ---- test/test.js | 40 - test/test.main.js | 669 --- 47 files changed, 4872 insertions(+), 6343 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/.keepalive delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (97%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/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 b6b01f0..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2025-03-10T00:34:06.747Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 9c9e251..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/flatten) 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 6213d2a..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/flatten) 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 1368f05..0000000 --- a/.github/workflows/npm_downloads.yml +++ /dev/null @@ -1,112 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: npm_downloads - -# Workflow triggers: -on: - # Run this workflow weekly: - schedule: - # cron: ' ' - - cron: '43 19 * * 4' - - # 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 + + ```
@@ -206,7 +203,7 @@ out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); ## 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]. @@ -271,7 +268,7 @@ Copyright © 2016-2025. The Stdlib [Authors][stdlib-authors]. -[@stdlib/array/base/flatten-by]: https://github.com/stdlib-js/array-base-flatten-by +[@stdlib/array/base/flatten-by]: https://github.com/stdlib-js/array-base-flatten-by/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 fe84dbe..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,401 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib' ); - - -// MAIN // - -bench( pkg+':ndims=2,size=100,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], false ); - 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+':ndims=2,size=100,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 10, 10 ], true ); - 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:ndims=2,size=100,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], false, out, 1, 0 ); - 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:ndims=2,size=100,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 100 ); - x = filled( zeroTo( 10 ), 10 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 10, 10 ], true, out, 1, 0 ); - 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+':ndims=3,size=125,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], false ); - 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+':ndims=3,size=125,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 5, 5, 5 ], true ); - 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:ndims=3,size=125,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], false, out, 1, 0 ); - 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:ndims=3,size=125,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 125 ); - x = filled( filled( zeroTo( 5 ), 5 ), 5 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 5, 5, 5 ], true, out, 1, 0 ); - 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+':ndims=4,size=144,lexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], false ); - 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+':ndims=4,size=144,colexicographic', function benchmark( b ) { - var x; - var i; - var v; - - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten( x, [ 4, 3, 4, 3 ], true ); - 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:ndims=4,size=144,lexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], false, out, 1, 0 ); - 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:ndims=4,size=144,colexicographic', function benchmark( b ) { - var out; - var x; - var i; - var v; - - out = new Float64Array( 144 ); - x = filled( filled( filled( zeroTo( 3 ), 4 ), 3 ), 4 ); - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - v = flatten.assign( x, [ 4, 3, 4, 3 ], true, out, 1, 0 ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], false ); - 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+':ndims=5,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 = flatten( x, [ 2, 2, 3, 3, 3 ], true ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], false, out, 1, 0 ); - 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:ndims=5,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 = flatten.assign( x, [ 2, 2, 3, 3, 3 ], true, out, 1, 0 ); - 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 14a9d67..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/flatten" -%% click B href "https://github.com/stdlib-js/array-base-flatten/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-flatten/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-flatten/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-flatten/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-flatten/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/flatten -[production-url]: https://github.com/stdlib-js/array-base-flatten/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-flatten/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-flatten/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-flatten/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-flatten/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-flatten/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-flatten/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 411a0a8..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import flatten from '../docs/types/index'; -export = flatten; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 805701f..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var s=function(a,r){return function(){return r||a((r={exports:{}}).exports,r),r.exports}};var x=s(function(I,L){ -var D=require('@stdlib/ndarray-base-shape2strides/dist'),E=require('@stdlib/ndarray-base-vind2bind/dist'),F=require('@stdlib/ndarray-base-numel/dist'),w=require('@stdlib/blas-ext-base-grev/dist'),y=require('@stdlib/array-base-zeros/dist'),G="throw";function z(a,r,n,e,u){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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// MODULES //\n\nvar numel = require( '@stdlib/ndarray-base-numel' );\nvar zeros = require( '@stdlib/array-base-zeros' );\nvar assign = require( './assign.js' );\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nmodule.exports = flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* var Float64Array = require( '@stdlib/array-float64' );\n* var flatten = require( '@stdlib/array-base-flatten' );\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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,cAsBA,IAAIC,EAAgB,QAAS,oCAAqC,EAC9DC,EAAY,QAAS,gCAAiC,EACtDC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAO,QAAS,4BAA6B,EAC7CC,EAAQ,QAAS,0BAA2B,EAK5CC,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,EAAS,CAC1C,IAAI,EACJ,IAAM,EAAI,EAAG,EAAIH,EAAG,IACnBC,EAAKE,CAAO,EAAIJ,EAAG,CAAE,EACrBI,GAAUD,CAEZ,CAeA,SAASE,EAAsBL,EAAGM,EAAOC,EAAOC,EAAKN,EAAKC,EAAQC,EAAS,CAC1E,IAAIK,EACAC,EACAC,EACAC,EAOJ,IAJAD,EAAIH,EAAM,EACVC,EAAQE,IAAML,EAEdI,EAAIH,EAAOC,CAAI,EACTI,EAAI,EAAGA,EAAIF,EAAGE,IACdH,GACJP,EAAKE,CAAO,EAAIJ,EAAGY,CAAE,EACrBR,GAAUD,GAEVC,EAASC,EAAsBL,EAAGY,CAAE,EAAGN,EAAOC,EAAOI,EAAGT,EAAKC,EAAQC,CAAO,EAG9E,OAAOA,CACR,CAaA,SAASS,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,EAAS,CACvE,IAAIU,EACAC,EACAC,EACAC,EACAC,EACA,EACAN,EAwBJ,IAnBAE,EAAMnB,EAAOY,CAAM,EAGnBQ,EAAMlB,EAAOiB,CAAI,EACjBT,EAAsBL,EAAGM,EAAOC,EAAO,EAAGQ,EAAK,EAAG,CAAE,EAGpDC,EAAM,YAGNE,EAAKzB,EAAec,EAAOS,CAAI,EAG/BC,EAAKpB,EAAOS,CAAM,EAClBP,EAAMQ,EAAOD,EAAOW,EAAI,EAAG,CAAE,EAC7BrB,EAAMU,EAAOW,EAAI,CAAE,EACnBrB,EAAMU,EAAOY,EAAI,CAAE,EAGbN,EAAI,EAAGA,EAAIE,EAAKF,IACrB,EAAIlB,EAAWuB,EAAIC,EAAI,EAAGF,EAAKJ,EAAGd,CAAK,EACvCI,EAAKE,CAAO,EAAIW,EAAK,CAAE,EACvBX,GAAUD,CAEZ,CAoCA,SAASgB,EAASnB,EAAGO,EAAOa,EAAiBlB,EAAKC,EAAQC,EAAS,CAClE,IAAIE,EAAQC,EAAM,OAClB,OAAKD,IAAU,EACPJ,EAEHI,IAAU,GAEdP,EAAMC,EAAGO,EAAO,CAAE,EAAGL,EAAKC,EAAQC,CAAO,EAClCF,GAEHkB,GACJP,EAAwBb,EAAGM,EAAOC,EAAOL,EAAKC,EAAQC,CAAO,EACtDF,IAERG,EAAsBL,EAAGM,EAAOC,EAAO,EAAGL,EAAKC,EAAQC,CAAO,EACvDF,EACR,CAKAV,EAAO,QAAU2B,IC1MjB,IAAAE,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAsBA,IAAIC,EAAQ,QAAS,4BAA6B,EAC9CC,EAAQ,QAAS,0BAA2B,EAC5CC,EAAS,IA6Bb,SAASC,EAASC,EAAGC,EAAOC,EAAkB,CAC7C,IAAIC,EAAMN,EAAOD,EAAOK,CAAM,CAAE,EAChC,OAAOH,EAAQE,EAAGC,EAAOC,EAAiBC,EAAK,EAAG,CAAE,CACrD,CAKAR,EAAO,QAAUI,ICJjB,IAAIK,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_assign", "__commonJSMin", "exports", "module", "shape2strides", "vind2bind", "numel", "grev", "zeros", "MODE", "copy", "x", "N", "out", "stride", "offset", "recurseLexicographic", "ndims", "shape", "dim", "FLG", "S", "d", "i", "flattenColexicographic", "len", "tmp", "ord", "sh", "sx", "flatten", "colexicographic", "require_main", "__commonJSMin", "exports", "module", "numel", "zeros", "assign", "flatten", "x", "shape", "colexicographic", "out", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 5a284fb..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,80 +0,0 @@ - -{{alias}}( x, shape, colexicographic ) - Flattens an n-dimensional nested array. - - The function assumes that all nested arrays have the same length (i.e., the - input array is *not* a ragged array). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: boolean - Specifies whether to flatten array values in colexicographic order. - - Returns - ------- - out: Array - Flattened array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = {{alias}}( x, [ 2, 2 ], false ) - [ 1, 2, 3, 4 ] - > out = {{alias}}( x, [ 2, 2 ], true ) - [ 1, 3, 2, 4 ] - - -{{alias}}.assign( x, shape, colexicographic, out, stride, offset ) - Flattens an n-dimensional nested array 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). - - Parameters - ---------- - x: Array - Input array. - - shape: Array - Array shape. - - colexicographic: 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. - - Returns - ------- - out: Array - Output array. - - Examples - -------- - > var x = [ [ 1, 2 ], [ 3, 4 ] ]; - > var out = [ 0, 0, 0, 0 ]; - > var v = {{alias}}.assign( x, [ 2, 2 ], false, out, 1, 0 ) - [ 1, 2, 3, 4 ] - > var bool = ( v === out ) - true - > out = [ 0, 0, 0, 0 ]; - > {{alias}}.assign( x, [ 2, 2 ], true, out, 1, 0 ); - > out - [ 1, 3, 2, 4 ] - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 0e13bd4..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,194 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 flatten = require( './index' ); - - -// TESTS // - -// The function returns an array... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten( x, [ 2, 2 ], false ); // $ExpectType number[] - flatten( x, [ 2, 2 ], true ); // $ExpectType number[] - - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false ); // $ExpectType string[] - flatten( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true ); // $ExpectType string[] -} - -// The compiler throws an error if the function is provided a first argument which is not an array-like object... -{ - flatten( 1, [ 2, 2 ], false ); // $ExpectError - flatten( true, [ 2, 2 ], false ); // $ExpectError - flatten( false, [ 2, 2 ], false ); // $ExpectError - flatten( null, [ 2, 2 ], false ); // $ExpectError - flatten( void 0, [ 2, 2 ], false ); // $ExpectError - flatten( {}, [ 2, 2 ], false ); // $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 ] ]; - - flatten( x, '', false ); // $ExpectError - flatten( x, 1, false ); // $ExpectError - flatten( x, true, false ); // $ExpectError - flatten( x, false, false ); // $ExpectError - flatten( x, null, false ); // $ExpectError - flatten( x, void 0, false ); // $ExpectError - flatten( x, {}, false ); // $ExpectError - flatten( x, [ 1, '2', 3 ], false ); // $ExpectError - flatten( x, ( x: number ): number => x, false ); // $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 ] ]; - - flatten( x, [ 2, 2 ], '' ); // $ExpectError - flatten( x, [ 2, 2 ], 1 ); // $ExpectError - flatten( x, [ 2, 2 ], null ); // $ExpectError - flatten( x, [ 2, 2 ], void 0 ); // $ExpectError - flatten( x, [ 2, 2 ], {} ); // $ExpectError - flatten( x, [ 2, 2 ], [] ); // $ExpectError - flatten( x, [ 2, 2 ], ( x: number ): number => x ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ 1, 2 ], [ 3, 4 ] ]; - - flatten(); // $ExpectError - flatten( x ); // $ExpectError - flatten( x, [ 2, 2 ] ); // $ExpectError - flatten( x, [ 2, 2 ], false, {} ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out1, 1, 0 ); // $ExpectType Collection - flatten.assign( x, [ 2, 2 ], true, out1, 1, 0 ); // $ExpectType Collection - - const out2 = [ '', '', '', '' ]; - - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], false, out2, 1, 0 ); // $ExpectType Collection - flatten.assign( [ [ '1', '2' ], [ '3', '4' ] ], [ 2, 2 ], true, out2, 1, 0 ); // $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 ]; - - flatten.assign( 1, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( true, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( false, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( null, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( void 0, [ 2, 2 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( {}, [ 2, 2 ], false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, '', false, out, 1, 0 ); // $ExpectError - flatten.assign( x, 1, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, true, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, false, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, null, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, void 0, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, {}, false, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 1, '2', 3 ], false, out, 1, 0 ); // $ExpectError - flatten.assign( x, ( x: number ): number => x, false, out, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], '', out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], 1, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], null, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], void 0, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], {}, out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], [], out, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], ( x: number ): number => x, out, 1, 0 ); // $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 ] ]; - - flatten.assign( x, [ 2, 2 ], false, 1, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, true, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, false, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, null, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, void 0, 1, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, {}, 1, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, '1', 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, true, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, false, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, null, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, void 0, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, {}, 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, [], 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, ( x: number ): number => x, 0 ); // $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 ]; - - flatten.assign( x, [ 2, 2 ], false, out, 1, '1' ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, true ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, null ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, void 0 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, {} ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, [] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, ( x: number ): number => x ); // $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 ]; - - flatten.assign(); // $ExpectError - flatten.assign( x ); // $ExpectError - flatten.assign( x, [ 2, 2 ] ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1 ); // $ExpectError - flatten.assign( x, [ 2, 2 ], false, out, 1, 0, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index 2d5a953..0000000 --- a/examples/index.js +++ /dev/null @@ -1,81 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 flatten = require( './../lib' ); - -// Define a 2x2x1x2x2 array: -var x = [ - [ - [ - [ - [ 1, 2 ], [ 3, 4 ] - ] - ], - [ - [ - [ 5, 6 ], [ 7, 8 ] - ] - ] - ], - [ - [ - [ - [ 9, 10 ], [ 11, 12 ] - ] - ], - [ - [ - [ 13, 14 ], [ 15, 16 ] - ] - ] - ] -]; - -var out = flatten( x, [ 0, 0, 0, 0, 0 ], false ); -console.log( out ); -// => [] - -out = flatten( x, [ 0, 0, 0, 0, 0 ], true ); -console.log( out ); -// => [] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], false ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 1, 1, 1, 1 ], true ); -console.log( out ); -// => [ 1 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8 ] - -out = flatten( x, [ 1, 2, 1, 2, 2 ], true ); -console.log( out ); -// => [ 1, 5, 3, 7, 2, 6, 4, 8 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], false ); -console.log( out ); -// => [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16 ] - -out = flatten( x, [ 2, 2, 1, 2, 2 ], true ); -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 97% rename from docs/types/index.d.ts rename to index.d.ts index 08cee6e..f0d5447 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Collection, Array1D, Array2D, Array3D, Array4D, Array5D, Array6D, Array7D, Array8D, Array9D, Array10D } from '@stdlib/types/array'; import { Shape } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..096cdaa --- /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 s from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";import r from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-numel@v0.2.2-esm/index.mjs";import e from"https://cdn.jsdelivr.net/gh/stdlib-js/array-base-zeros@v0.2.2-esm/index.mjs";import t from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-shape2strides@v0.2.2-esm/index.mjs";import n from"https://cdn.jsdelivr.net/gh/stdlib-js/ndarray-base-vind2bind@v0.2.2-esm/index.mjs";import i from"https://cdn.jsdelivr.net/gh/stdlib-js/blas-ext-base-grev@v0.2.1-esm/index.mjs";var d="throw";function a(s,r,e,t,n){var i;for(i=0;i[ 1, 2, 3, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic, out, stride, offset ) {\n\tvar ndims = shape.length;\n\tif ( ndims === 0 ) { // 0-dimensional array\n\t\treturn out;\n\t}\n\tif ( ndims === 1 ) { // 1-dimensional array\n\t\t// For 1-dimensional arrays, we can perform a simple copy:\n\t\tcopy( x, shape[ 0 ], out, stride, offset );\n\t\treturn out;\n\t}\n\tif ( colexicographic ) {\n\t\tflattenColexicographic( x, ndims, shape, out, stride, offset );\n\t\treturn out;\n\t}\n\trecurseLexicographic( x, ndims, shape, 0, out, stride, offset );\n\treturn out;\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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// MODULES //\n\nimport numel from '@stdlib/ndarray-base-numel';\nimport zeros from '@stdlib/array-base-zeros';\nimport assign from './assign.js';\n\n\n// MAIN //\n\n/**\n* Flattens an n-dimensional nested 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* @returns {Array} flattened array\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*/\nfunction flatten( x, shape, colexicographic ) {\n\tvar out = zeros( numel( shape ) );\n\treturn assign( x, shape, colexicographic, out, 1, 0 );\n}\n\n\n// EXPORTS //\n\nexport default flatten;\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 an n-dimensional nested array.\n*\n* @module @stdlib/array-base-flatten\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], false );\n* // returns [ 1, 2, 3, 4 ]\n*\n* @example\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = flatten( x, [ 2, 2 ], true );\n* // returns [ 1, 3, 2, 4 ]\n*\n* @example\n* import Float64Array from '@stdlib/array-float64';\n* import flatten from '@stdlib/array-base-flatten';\n*\n* var x = [ [ 1, 2 ], [ 3, 4 ] ];\n*\n* var out = new Float64Array( 4 );\n* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 );\n* // returns [ 1, 3, 2, 4 ]\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":["MODE","copy","x","N","out","stride","offset","i","recurseLexicographic","ndims","shape","dim","FLG","S","d","flatten","colexicographic","length","len","tmp","ord","sh","sx","j","numel","zeros","shape2strides","grev","vind2bind","flattenColexicographic","assign","setReadOnly","main"],"mappings":";;mlBA+BA,IAAIA,EAAO,QAwBX,SAASC,EAAMC,EAAGC,EAAGC,EAAKC,EAAQC,GACjC,IAAIC,EACJ,IAAMA,EAAI,EAAGA,EAAIJ,EAAGI,IACnBH,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,CAEZ,CAeA,SAASG,EAAsBN,EAAGO,EAAOC,EAAOC,EAAKP,EAAKC,EAAQC,GACjE,IAAIM,EACAC,EACAC,EACAP,EAOJ,IAHAK,GADAE,EAAIH,EAAM,KACIF,EAEdI,EAAIH,EAAOC,GACLJ,EAAI,EAAGA,EAAIM,EAAGN,IACdK,GACJR,EAAKE,GAAWJ,EAAGK,GACnBD,GAAUD,GAEVC,EAASE,EAAsBN,EAAGK,GAAKE,EAAOC,EAAOI,EAAGV,EAAKC,EAAQC,GAGvE,OAAOA,CACR,CAqFA,SAASS,EAASb,EAAGQ,EAAOM,EAAiBZ,EAAKC,EAAQC,GACzD,IAAIG,EAAQC,EAAMO,OAClB,OAAe,IAAVR,EACGL,EAEO,IAAVK,GAEJR,EAAMC,EAAGQ,EAAO,GAAKN,EAAKC,EAAQC,GAC3BF,GAEHY,GAlFN,SAAiCd,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC9D,IAAIY,EACAC,EACAC,EACAC,EACAC,EACAC,EACAhB,EAwBJ,IAnBAW,EAAMM,EAAOd,GAIbF,EAAsBN,EAAGO,EAAOC,EAAO,EADvCS,EAAMM,EAAOP,GACkC,EAAG,GAMlDI,EAAKI,EAAehB,EAHpBU,EAAM,aAONnB,EAAMS,EAAOD,EADbY,EAAKI,EAAOhB,GACY,EAAG,GAC3BkB,EAAMlB,EAAOY,EAAI,GACjBM,EAAMlB,EAAOa,EAAI,GAGXf,EAAI,EAAGA,EAAIW,EAAKX,IACrBgB,EAAIK,EAAWP,EAAIC,EAAI,EAAGF,EAAKb,EAAGP,GAClCI,EAAKE,GAAWa,EAAKI,GACrBjB,GAAUD,CAEZ,CA+CEwB,CAAwB3B,EAAGO,EAAOC,EAAON,EAAKC,EAAQC,GAC/CF,IAERI,EAAsBN,EAAGO,EAAOC,EAAO,EAAGN,EAAKC,EAAQC,GAChDF,EACR,CChJA,SAASW,EAASb,EAAGQ,EAAOM,GAE3B,OAAOc,EAAQ5B,EAAGQ,EAAOM,EADfS,EAAOD,EAAOd,IACuB,EAAG,EACnD,CCQAqB,EAAAC,EAAA,SAAAF"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index ea014f1..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,203 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var shape2strides = require( '@stdlib/ndarray-base-shape2strides' ); -var vind2bind = require( '@stdlib/ndarray-base-vind2bind' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var grev = require( '@stdlib/blas-ext-base-grev' ); -var zeros = require( '@stdlib/array-base-zeros' ); - - -// VARIABLES // - -var MODE = 'throw'; - - -// FUNCTIONS // - -/** -* Copies a specified number of array elements to a provided array. -* -* @private -* @param {Array} x - input array -* @param {NonNegativeInteger} N - number of elements to copy -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* -* @example -* var x = [ 1, 2, 3, 4 ]; -* -* var out = [ 0, 0, 0 ]; -* copy( x, 3, out, 1, 0 ); -* -* var o = out; -* // returns [ 1, 2, 3 ] -*/ -function copy( x, N, out, stride, offset ) { - var i; - for ( i = 0; i < N; i++ ) { - out[ offset ] = x[ i ]; - offset += stride; - } -} - -/** -* Recursively flattens an array in lexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {NonNegativeInteger} dim - dimension index -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -* @returns {NonNegativeInteger} offset for next output array element -*/ -function recurseLexicographic( x, ndims, shape, dim, out, stride, offset ) { - var FLG; - var S; - var d; - var i; - - // Check whether we've reached the last dimension: - d = dim + 1; - FLG = ( d === ndims ); - - S = shape[ dim ]; - for ( i = 0; i < S; i++ ) { - if ( FLG ) { - out[ offset ] = x[ i ]; - offset += stride; - } else { - offset = recurseLexicographic( x[ i ], ndims, shape, d, out, stride, offset ); // eslint-disable-line max-len - } - } - return offset; -} - -/** -* Flattens an array in colexicographic order. -* -* @private -* @param {Array} x - array to flatten -* @param {NonNegativeInteger} ndims - number of dimensions in the input array -* @param {NonNegativeIntegerArray} shape - shape of the input array -* @param {Collection} out - output array -* @param {integer} stride - output array stride -* @param {NonNegativeInteger} offset - output array offset -*/ -function flattenColexicographic( x, ndims, shape, out, stride, offset ) { - var len; - var tmp; - var ord; - var sh; - var sx; - var j; - var i; - - // Note that, in contrast to lexicographic iteration, we cannot readily define a straightforward recursive definition for colexicographic iteration. Accordingly, we have to perform a workaround in which we first flatten in lexicographic order and then perform an out-of-place transposition to return an array in colexicographic order. - - // Determine how many elements will be in the output array: - len = numel( shape ); - - // For input arrays having an arbitrary number of dimensions, first flatten in lexicographic order: - tmp = zeros( len ); - recurseLexicographic( x, ndims, shape, 0, tmp, 1, 0 ); - - // Define the memory layout: - ord = 'row-major'; - - // Generate a stride array for lexicographic order: - sx = shape2strides( shape, ord ); - - // Reverse the dimensions and strides (i.e., define the shape and strides of the transpose): - sh = zeros( ndims ); - copy( shape, ndims, sh, 1, 0 ); - grev( ndims, sh, 1 ); - grev( ndims, sx, 1 ); - - // Iterate over each element based on the linear **view** index (note: this has negative performance implications due to lack of data locality)... - for ( i = 0; i < len; i++ ) { - j = vind2bind( sh, sx, 0, ord, i, MODE ); - out[ offset ] = tmp[ j ]; - offset += stride; - } -} - - -// MAIN // - -/** -* Flattens an n-dimensional nested array 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 -* @returns {Collection} output array -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true, new Float64Array( 4 ), 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic, out, stride, offset ) { - var ndims = shape.length; - if ( ndims === 0 ) { // 0-dimensional array - return out; - } - if ( ndims === 1 ) { // 1-dimensional array - // For 1-dimensional arrays, we can perform a simple copy: - copy( x, shape[ 0 ], out, stride, offset ); - return out; - } - if ( colexicographic ) { - flattenColexicographic( x, ndims, shape, out, stride, offset ); - return out; - } - recurseLexicographic( x, ndims, shape, 0, out, stride, offset ); - return out; -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index e12dbdf..0000000 --- a/lib/index.js +++ /dev/null @@ -1,70 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR 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 an n-dimensional nested array. -* -* @module @stdlib/array-base-flatten -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -* -* @example -* var Float64Array = require( '@stdlib/array-float64' ); -* var flatten = require( '@stdlib/array-base-flatten' ); -* -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = new Float64Array( 4 ); -* var y = flatten.assign( x, [ 2, 2 ], true, out, 1, 0 ); -* // returns [ 1, 3, 2, 4 ] -* -* 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 ec08f0a..0000000 --- a/lib/main.js +++ /dev/null @@ -1,62 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MODULES // - -var numel = require( '@stdlib/ndarray-base-numel' ); -var zeros = require( '@stdlib/array-base-zeros' ); -var assign = require( './assign.js' ); - - -// MAIN // - -/** -* Flattens an n-dimensional nested 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 -* @returns {Array} flattened array -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], false ); -* // returns [ 1, 2, 3, 4 ] -* -* @example -* var x = [ [ 1, 2 ], [ 3, 4 ] ]; -* -* var out = flatten( x, [ 2, 2 ], true ); -* // returns [ 1, 3, 2, 4 ] -*/ -function flatten( x, shape, colexicographic ) { - var out = zeros( numel( shape ) ); - return assign( x, shape, colexicographic, out, 1, 0 ); -} - - -// EXPORTS // - -module.exports = flatten; diff --git a/package.json b/package.json index afd8ac4..2694041 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Flatten an n-dimensional nested array.", "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,43 +13,6 @@ "bugs": { "url": "https://github.com/stdlib-js/stdlib/issues" }, - "dependencies": { - "@stdlib/array-base-zeros": "^0.2.2", - "@stdlib/blas-ext-base-grev": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/ndarray-base-shape2strides": "^0.2.2", - "@stdlib/ndarray-base-vind2bind": "^0.2.2", - "@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", - "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", @@ -91,4 +31,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..ea0dd2b --- /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 b40b29e..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,898 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 Float64Array = require( '@stdlib/array-float64' ); -var flatten = require( './../lib/assign.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var out; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 4 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6, 3, 7 ] ); - out = new Float64Array( 6 ); - actual = flatten( x, [ 2, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ] ); - out = new Float64Array( 9 ); - actual = flatten( x, [ 3, 3 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 4 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 4, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ] ); - out = new Float64Array( 12 ); - actual = flatten( x, [ 3, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 4, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 2, 6, 10, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 4, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ] ); // eslint-disable-line max-len - out = new Float64Array( 16 ); - actual = flatten( x, [ 4, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 3, 4, 5, 6, 7, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 9, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2, 5, 6, 9, 10, 13, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [] ); - out = new Float64Array( 0 ); - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1 ] ); - out = new Float64Array( 1 ); - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 2 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9 ] ); - out = new Float64Array( 2 ); - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 2, 6 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 5, 3, 7, 2, 6, 4, 8 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13 ] ); - out = new Float64Array( 4 ); - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true, out, 1, 0 ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = new Float64Array( [ 1, 9, 5, 13, 2, 10, 6, 14 ] ); - out = new Float64Array( 8 ); - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true, out, 1, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], true, out, 2, 0 ); - 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 = flatten( x, [ 2, 2 ], false, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], true, out, 1, 2 ); - 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 = flatten( x, [ 2, 2 ], false, out, -2, 7 ); - 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 = flatten( x, [ 2, 2 ], true, out, -2, 7 ); - t.strictEqual( actual, out, 'returns expected value' ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index 4f92d41..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 flatten = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( hasOwnProp( flatten, 'assign' ), true, 'has property' ); - t.strictEqual( typeof flatten.assign, 'function', 'has method' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index 89f8c01..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,669 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 flatten = require( './../lib/main.js' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof flatten, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function flattens an array (0d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens an array (1d)', function test( t ) { - var expected; - var actual; - var x; - - x = [ 1, 2, 3, 4 ]; - - expected = []; - actual = flatten( x, [ 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4 ]; - actual = flatten( x, [ 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7 ]; - actual = flatten( x, [ 2, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 5, 6, 7, 9, 10, 11 ]; - actual = flatten( x, [ 3, 3 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 2 ], false ); - 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 = flatten( x, [ 4, 4 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 2d)', 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 = flatten( x, [ 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6, 3, 7 ]; - actual = flatten( x, [ 2, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 2, 6, 10, 3, 7, 11 ]; - actual = flatten( x, [ 3, 3 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14, 3, 7, 11, 15, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 4 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], false ); - 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 = flatten( x, [ 4, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 3d)', 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 = flatten( x, [ 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5 ]; - actual = flatten( x, [ 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 3, 7, 11, 2, 6, 10, 4, 8, 12 ]; - actual = flatten( x, [ 3, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 4, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 2, 6, 10, 14 ]; - actual = flatten( x, [ 4, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13, 3, 7, 11, 15, 2, 6, 10, 14, 4, 8, 12, 16 ]; - actual = flatten( x, [ 4, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 4d)', 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 = flatten( x, [ 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (lexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 3, 4, 5, 6, 7, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 9, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2, 5, 6, 9, 10, 13, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], false ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], false ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -}); - -tape( 'the function flattens a nested array (colexicographic; 5d)', 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 = flatten( x, [ 0, 0, 0, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 0, 0, 1, 0, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = []; - actual = flatten( x, [ 1, 0, 0, 1, 0 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1 ]; - actual = flatten( x, [ 1, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 2 ]; - actual = flatten( x, [ 1, 1, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9 ]; - actual = flatten( x, [ 2, 1, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 2, 6 ]; - actual = flatten( x, [ 1, 2, 1, 1, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 5, 3, 7, 2, 6, 4, 8 ]; - actual = flatten( x, [ 1, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13 ]; - actual = flatten( x, [ 2, 2, 1, 1, 1 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - expected = [ 1, 9, 5, 13, 2, 10, 6, 14 ]; - actual = flatten( x, [ 2, 2, 1, 1, 2 ], true ); - 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 = flatten( x, [ 2, 2, 1, 2, 2 ], true ); - t.deepEqual( actual, expected, 'returns expected value' ); - - t.end(); -});