From 9701e055d994019821a9342776e2dc3eeabb22af Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 22 Nov 2023 22:08:56 +0000 Subject: [PATCH 01/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 7e3c377..f894e2f 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 77f1b85900885a19c8a22b7e64eaf38cce900a38 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 22 Nov 2023 22:12:02 +0000 Subject: [PATCH 02/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 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 | 57 +- benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 45 files changed, 6214 insertions(+), 4647 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 ccbe323..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA 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 + + ```
@@ -197,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 19338ed..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index fe79ee3..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index c069a4e..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d60c992..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array> - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array> -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array> - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array> -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 25ad4e7..97dedc2 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..503e78a --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index f894e2f..74d1db6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.0.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..9cb9d78 --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 3a3c86763ac323c366b5c45debbcfd21dff3f48e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:11:36 +0000 Subject: [PATCH 03/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 889abe3..2935cac 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 8eb1e53bc46b246acfd98e36ad8aff7d232c39e3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:17:15 +0000 Subject: [PATCH 04/99] Remove files --- index.d.ts | 185 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6367 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 97dedc2..0000000 --- a/index.d.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * var zeros3d = require( `@stdlib/array/base/zeros3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* var zeros3d = require( `@stdlib/array/base/zeros3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 503e78a..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 9cb9d78..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 4db87c87b3edd06607b2a998fbb2369660f3736d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:19:53 +0000 Subject: [PATCH 05/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 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 | 57 +- benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 45 files changed, 6214 insertions(+), 4647 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 ccbe323..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA 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 + + ```
@@ -197,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 19338ed..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index fe79ee3..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index c069a4e..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d60c992..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array> - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array> -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array> - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array> -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 25ad4e7..97dedc2 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..503e78a --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 2935cac..80769a9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..f7cd255 --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 2fc9cc838d5e3e9750e0d12bfdaaa5ec891f18b3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:20:12 +0000 Subject: [PATCH 06/99] Update README.md for ESM bundle v0.1.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 6299cd4..bee33c4 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ limitations under the License. ## Usage ```javascript -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@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-map3d@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.1.0-esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +160,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.1.0-esm/index.mjs'; var shape = [ 3, 3, 3 ]; From 3fe0db94cf397fd60d96f3648ac4ebe15fd30328 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:20:13 +0000 Subject: [PATCH 07/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bee33c4..7023443 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,11 @@ limitations under the License. ## Usage +```javascript +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-map3d/tags). For example, + ```javascript import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.1.0-esm/index.mjs'; ``` @@ -54,7 +59,7 @@ import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.1.0 You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.1.0-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +165,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.1.0-esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; var shape = [ 3, 3, 3 ]; From 28f65f0eedff60140ab075b26dc582ee5a9b343a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:42:30 +0000 Subject: [PATCH 08/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 889abe3..2935cac 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e8d8f0b96cceaabb0b00a1c9e0dede81fe882ac2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:42:52 +0000 Subject: [PATCH 09/99] Remove files --- index.d.ts | 185 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6367 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 97dedc2..0000000 --- a/index.d.ts +++ /dev/null @@ -1,185 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * var zeros3d = require( `@stdlib/array/base/zeros3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* var zeros3d = require( `@stdlib/array/base/zeros3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 503e78a..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index f7cd255..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9f214a154fca88d74306ddf3a0a33c7fa7e19c4e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 23 Nov 2023 19:45:30 +0000 Subject: [PATCH 10/99] Auto-generated commit --- .editorconfig | 186 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 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 | 57 +- benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 45 files changed, 6214 insertions(+), 4647 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 13e9c39..0000000 --- a/.editorconfig +++ /dev/null @@ -1,186 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tslint.json` files: -[tslint.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 ccbe323..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA 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 + + ```
@@ -197,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 19338ed..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index fe79ee3..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index c069a4e..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index d60c992..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array> - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array> -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array> - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array> -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 073d21b..0d6e07d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..503e78a --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 2935cac..80769a9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..1f73a74 --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From b9eca6782bcfce3a389ec315c19c96fe4558b655 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 28 Nov 2023 23:07:58 +0000 Subject: [PATCH 11/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 889abe3..2935cac 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e7be7753175a6da9bdc9bdd212b4c5efee28756e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 28 Nov 2023 23:08:22 +0000 Subject: [PATCH 12/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6368 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 0d6e07d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * var zeros3d = require( `@stdlib/array/base/zeros3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* var zeros3d = require( `@stdlib/array/base/zeros3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 503e78a..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 1f73a74..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From a08119178fa6c5419960ecc991093fca8b52cd32 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 28 Nov 2023 23:11:08 +0000 Subject: [PATCH 13/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 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 | 57 +- benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 45 files changed, 6214 insertions(+), 4642 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 ccbe323..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA 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 + + ```
@@ -197,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 19338ed..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index fe79ee3..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index c069a4e..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 073d21b..0d6e07d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..503e78a --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 2935cac..80769a9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..7551327 --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From b3b755b95971716efda8c85f1ed3a28702ca3e56 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Dec 2023 11:36:53 +0000 Subject: [PATCH 14/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 889abe3..2935cac 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 7847c9fc2cdd7ed4f0b48ab3a8408ad9bc5c35ad Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 08:48:33 +0000 Subject: [PATCH 15/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6368 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 0d6e07d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * var zeros3d = require( `@stdlib/array/base/zeros3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* var zeros3d = require( `@stdlib/array/base/zeros3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 503e78a..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 7551327..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9af713804aff5947773a95830217bd86dbb0bfcd Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 2 Dec 2023 08:51:16 +0000 Subject: [PATCH 16/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 227 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 57 +- benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 46 files changed, 6214 insertions(+), 4643 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 39f66a6..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2023-12-01T04:47:41.155Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 ccbe323..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA 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 + + ```
@@ -197,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 19338ed..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index fe79ee3..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index c069a4e..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 073d21b..0d6e07d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..503e78a --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 2935cac..80769a9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/bench": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..d603b1b --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 7a7d41a836688bd6736ac8bc149187200ebccb3a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 06:53:36 +0000 Subject: [PATCH 17/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index fe5d753..0ac8072 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9388a5414b1d750b97621ff7c36e4f681473375e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 13:37:18 +0000 Subject: [PATCH 18/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6368 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 0d6e07d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * var zeros3d = require( `@stdlib/array/base/zeros3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* var zeros3d = require( `@stdlib/array/base/zeros3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 503e78a..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2023 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index d603b1b..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5d18af20a7553ef63bad974797db2b418511bcef Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Jan 2024 13:37:42 +0000 Subject: [PATCH 19/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 57 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 6214 insertions(+), 4649 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 130868e..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-01-01T04:14:01.561Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 0831f27..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA 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 + + ```
@@ -197,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index c069a4e..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 073d21b..0d6e07d 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ffa4c89 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 0ac8072..80769a9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@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", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..4058c25 --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 8c734bd2380e39b3ba9530cfa4126d4b83db954c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:11:40 +0000 Subject: [PATCH 20/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index fe5d753..0ac8072 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 74713dfd70120a953779c0d2d60a10c388152e20 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:29:08 +0000 Subject: [PATCH 21/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6368 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 0d6e07d..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( `@stdlib/array/base/ones3d` ); - * var zeros3d = require( `@stdlib/array/base/zeros3d` ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( `@stdlib/array/base/ones3d` ); -* var zeros3d = require( `@stdlib/array/base/zeros3d` ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index ffa4c89..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 4058c25..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b1c015df66051dc8d82033e83807403aaa77f941 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 7 Jan 2024 22:29:25 +0000 Subject: [PATCH 22/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 57 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 53 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 46 files changed, 6214 insertions(+), 4648 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 0831f27..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA 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 + + ```
@@ -197,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index c069a4e..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[esm-url]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ffa4c89 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 0ac8072..80769a9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@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", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..4ca5b39 --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From fa65ccbe9d32fcfbf1554841aa5dfada346a037d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 07:23:30 +0000 Subject: [PATCH 23/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index fe5d753..0ac8072 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.2.0", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.1.1", + "@stdlib/error-tools-fmtprodmsg": "^0.1.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From e325ff7400697f7fbc232fe47464a452014c103e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 12:55:28 +0000 Subject: [PATCH 24/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6368 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index ffa4c89..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 4ca5b39..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9ad426f0226bd1722de700c1d28cf8334b71d144 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Feb 2024 12:55:50 +0000 Subject: [PATCH 25/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 128 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 6214 insertions(+), 4654 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 51d587b..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-02-01T05:03:10.555Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 0831f27..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA 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 + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ef64990 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;iHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 0ac8072..80769a9 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.1.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.1.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@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", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..dfe00de --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 2c2bb20a7a765be550c92d9ad57e234d6ef6797a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 14:08:09 +0000 Subject: [PATCH 26/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 9829696..9279fd9 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.0", + "@stdlib/error-tools-fmtprodmsg": "^0.2.0" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.1.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 9bdc260b7a87df469cfd6a2530cba760192c6446 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 21:01:20 +0000 Subject: [PATCH 27/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6368 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index ef64990..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;iHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index dfe00de..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e2f3ee60015334f36da94dd4f59d60f3808af136 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 21:02:11 +0000 Subject: [PATCH 28/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 --- .github/workflows/publish.yml | 255 - .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 6177 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 46 files changed, 6214 insertions(+), 4657 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 ced074d..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA 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 + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..ffa4c89 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 9279fd9..2825b3a 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.0", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.1.0", - "@stdlib/array-base-zeros3d": "^0.1.0", - "@stdlib/math-base-assert-is-nan": "^0.1.1", - "@stdlib/math-base-special-abs": "^0.1.1", - "@stdlib/math-base-special-floor": "^0.1.1", - "@stdlib/math-base-special-identity": "^0.1.1", - "@stdlib/math-base-special-pow": "^0.1.0", - "@stdlib/ndarray-base-numel": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.1.0", - "@stdlib/random-base-uniform": "^0.1.0", - "@stdlib/utils-nary-function": "^0.2.0", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.0" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..e6bd9c7 --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 32d414d9b46cc82b0e490887e1e6f4a65553ecc6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 22:09:40 +0000 Subject: [PATCH 29/99] Update README.md for ESM bundle v0.2.0 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index fd0c797..ae3c71c 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ limitations under the License. ## Usage ```javascript -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@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-map3d@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.0-esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +160,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.0-esm/index.mjs'; var shape = [ 3, 3, 3 ]; From 550b7383b1a5acad3fa21f6d5e99da3804254b4a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 14 Feb 2024 22:09:40 +0000 Subject: [PATCH 30/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index ae3c71c..cd7a95f 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,11 @@ limitations under the License. ## Usage +```javascript +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-map3d/tags). For example, + ```javascript import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.0-esm/index.mjs'; ``` @@ -54,7 +59,7 @@ import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.0 You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.0-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +165,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.0-esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; var shape = [ 3, 3, 3 ]; From cce08b93394ff9068622333dc460e1d84f1b2b87 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 00:17:49 +0000 Subject: [PATCH 31/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index f293325..a1f1b8f 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.0", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From ce51eea0c64894856191ee6056460196edaa8b16 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 05:44:39 +0000 Subject: [PATCH 32/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 6177 ------------------------------------------------- 4 files changed, 6368 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index ffa4c89..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.1.0-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index e6bd9c7..0000000 --- a/stats.html +++ /dev/null @@ -1,6177 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 198ebcb17f7418355249af9e2bc30a747448bada Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 05:46:01 +0000 Subject: [PATCH 33/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 228 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 46 files changed, 4879 insertions(+), 4651 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index a1f1b8f..1946886 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.0", - "@stdlib/array-base-zeros3d": "^0.2.0", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.0", - "@stdlib/math-base-special-floor": "^0.2.1", - "@stdlib/math-base-special-identity": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.0", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.0", - "@stdlib/random-base-uniform": "^0.2.0", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 1046a4ff4e4f27661da35e05f425954f7da4f1ec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 07:25:41 +0000 Subject: [PATCH 34/99] Update README.md for ESM bundle v0.2.1 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 8f68882..9e3cce7 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ limitations under the License. ## Usage ```javascript -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@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-map3d@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.1-esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +160,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.1-esm/index.mjs'; var shape = [ 3, 3, 3 ]; From bace004d8b187628dba26319597dd40d0c2cbe6b Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 25 Feb 2024 07:25:41 +0000 Subject: [PATCH 35/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 9e3cce7..0f180dc 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,11 @@ limitations under the License. ## Usage +```javascript +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-map3d/tags). For example, + ```javascript import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.1-esm/index.mjs'; ``` @@ -54,7 +59,7 @@ import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.1 You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.1-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +165,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.1-esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; var shape = [ 3, 3, 3 ]; From 7ce80e485c99bff23ad0d509460a58334d4cfa75 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 06:45:50 +0000 Subject: [PATCH 36/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 898376a..2021735 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 12b42c5610c3da74ee0b699b22b47ce1d789babe Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 12:09:24 +0000 Subject: [PATCH 37/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 5f6aa74e527c6ff8f182198886aa131c53d1b482 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Mar 2024 12:09:51 +0000 Subject: [PATCH 38/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 28 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4653 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 9a19834..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-03-01T04:50:02.716Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 2021735..1946886 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.1", - "@stdlib/array-base-zeros3d": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.2.1", - "@stdlib/math-base-special-identity": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From d801a6752b5e1a6c590663d8c50236f6152a9882 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 06:02:33 +0000 Subject: [PATCH 39/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index e2676d8..2d94b20 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 777ba5a7757b36c63a7c4fb40ce4c51c63e7fd9a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 11:11:50 +0000 Subject: [PATCH 40/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 1b4f71221531bf695427f84832b1eae12709128c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 1 Apr 2024 11:12:01 +0000 Subject: [PATCH 41/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 132 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4656 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 4e57ff1..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-04-01T04:05:24.966Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 2d94b20..1946886 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.1", - "@stdlib/array-base-zeros3d": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.2.2", - "@stdlib/math-base-special-identity": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 7d2b490165f8fe88434ffde5bfc0fb8a881de26a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 02:25:18 +0000 Subject: [PATCH 42/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index e2676d8..2d94b20 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", + "@stdlib/error-tools-fmtprodmsg": "^0.2.1" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 4e1b9150b20564672f0f6a5809f2861f60827b59 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 07:53:50 +0000 Subject: [PATCH 43/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7440b8fe7444914aa2bd31ad202f025aa11cf350 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 12 Apr 2024 07:54:04 +0000 Subject: [PATCH 44/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 49 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 797 ---- .github/workflows/publish.yml | 249 -- .github/workflows/test.yml | 100 - .github/workflows/test_bundles.yml | 189 - .github/workflows/test_coverage.yml | 134 - .github/workflows/test_install.yml | 86 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 5 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 46 files changed, 4879 insertions(+), 4657 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 10a16e6..0000000 --- a/.gitattributes +++ /dev/null @@ -1,49 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/deps/** linguist-vendored=false -/lib/node_modules/** linguist-vendored=false linguist-generated=false -test/fixtures/** linguist-vendored=false -tools/** linguist-vendored=false - -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 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 + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 2d94b20..1946886 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.1", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.1", - "@stdlib/array-base-zeros3d": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.1", - "@stdlib/math-base-special-floor": "^0.2.2", - "@stdlib/math-base-special-identity": "^0.2.1", - "@stdlib/math-base-special-pow": "^0.2.1", - "@stdlib/ndarray-base-numel": "^0.2.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.1", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.1" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 1d7a36937a672bd7715767348107aa7d4bba5232 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:19:46 +0000 Subject: [PATCH 45/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 099ff32..0d41a8b 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.1", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From d2cc9e2bab38d164f9d3cde596462ef106c03473 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:36:19 +0000 Subject: [PATCH 46/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 9e64ef9997e76c0f29b2dba137cdcd0b4119f659 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:36:33 +0000 Subject: [PATCH 47/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 188 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 46 files changed, 4879 insertions(+), 4769 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 0d41a8b..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.1", - "@stdlib/array-base-zeros3d": "^0.2.1", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From bc263f985f7972ad20c944dc0451933d03474bb3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:44:59 +0000 Subject: [PATCH 48/99] Update README.md for ESM bundle v0.2.2 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 491c744..77abf8b 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ limitations under the License. ## Usage ```javascript -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.2-esm/index.mjs'; ``` You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.2-esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +160,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.2-esm/index.mjs'; var shape = [ 3, 3, 3 ]; From a20d96a46dde8afd63c56901aead812e7bbb53ab Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 21:45:00 +0000 Subject: [PATCH 49/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 77abf8b..326c035 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,11 @@ limitations under the License. ## Usage +```javascript +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-map3d/tags). For example, + ```javascript import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.2-esm/index.mjs'; ``` @@ -54,7 +59,7 @@ import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.2 You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.2-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +165,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.2-esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; var shape = [ 3, 3, 3 ]; From 615942be9e189d30f35375547c4d454303c8d446 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 06:52:51 +0000 Subject: [PATCH 50/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 09f35e2..1ab5c43 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From d84320787ebe25c4f326e182578f946da93ac60d Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 11:33:10 +0000 Subject: [PATCH 51/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From f3c400fe6ca6bec844a7eb9c7beb09de9bee504f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Thu, 1 Aug 2024 11:33:29 +0000 Subject: [PATCH 52/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 78 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4744 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 476b5a2..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-01T04:56:27.880Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 1ab5c43..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 2910df66529c2e7abdf9f22c8286d6542fae7109 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sat, 3 Aug 2024 22:03:49 +0000 Subject: [PATCH 53/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 09f35e2..1ab5c43 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From efddc8366345cdb6755907001c12cc318f55b835 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Aug 2024 01:16:38 +0000 Subject: [PATCH 54/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c90a62b0513e7c610f2930dcb930c7382e8de06e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 4 Aug 2024 01:16:53 +0000 Subject: [PATCH 55/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4772 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 6837382..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-08-03T20:24:29.477Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 1ab5c43..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.3.2", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 0ac6ba9576378dd54d18b44fa18e96f73dbad5a6 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 07:11:29 +0000 Subject: [PATCH 56/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 11dec1d..c4a9366 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 59a6e04bb76adde63653042feed17883e70b66df Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 11:25:44 +0000 Subject: [PATCH 57/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 54f0ce609bab788d19baf5ca9a6083fe98ab5756 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Sep 2024 11:26:03 +0000 Subject: [PATCH 58/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4772 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 3d3a8f9..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-09-01T05:16:26.808Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index c4a9366..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From c1015cd6f9665f8de6c15aa17e212782c7f95711 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 07:27:27 +0000 Subject: [PATCH 59/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 11dec1d..c4a9366 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 2c8f6964fdcea0bbc2473b3ce19a2d86e5012f7f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 12:04:05 +0000 Subject: [PATCH 60/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From c33159396d824323d698deaaafaa252f17c42cec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 1 Oct 2024 12:04:19 +0000 Subject: [PATCH 61/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4772 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 7b9cfb3..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-10-01T05:28:11.643Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index c4a9366..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 6b539493c6226e1a33b4a70f56f3e493c803819c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 07:19:44 +0000 Subject: [PATCH 62/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 11dec1d..c4a9366 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 19456b3c964f2d786388630c4cddae4912668a40 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 11:18:57 +0000 Subject: [PATCH 63/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d3097bc1b49220ee5343caff7ec13c635d62c94e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 1 Nov 2024 11:19:10 +0000 Subject: [PATCH 64/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 ---- .github/workflows/publish.yml | 252 -- .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 --- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 +++++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4772 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 2b52091..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-11-01T05:32:06.353Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index c4a9366..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.4.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", - "@stdlib/error-tools-fmtprodmsg": "^0.2.2" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From cfb2f13a0074f70b37e7dc5c6f049e1b4228fdd4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 07:35:32 +0000 Subject: [PATCH 65/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4109502..81c621d 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 78aa58f82a413bf78a66831d41c7988b97d5dec1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 11:29:31 +0000 Subject: [PATCH 66/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 7517d5af3d696d910bec474cce54dd319ba78c60 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 1 Dec 2024 11:29:47 +0000 Subject: [PATCH 67/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 48 files changed, 4879 insertions(+), 4877 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 60d743f..0000000 --- a/.editorconfig +++ /dev/null @@ -1,181 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 -insert_final_newline = false - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = false - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index c7b0398..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-01T05:40:38.189Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 81c621d..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From d1187f387a0ec0cd5ca18497fe0aae67e2b41b90 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 02:27:36 +0000 Subject: [PATCH 68/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4109502..81c621d 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 97ad2aa044d0d28ce7202e96c7c2d17819e42434 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 02:53:47 +0000 Subject: [PATCH 69/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b165d5a871503c0806d5b11ba75af57e4dc3ccf5 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 23 Dec 2024 02:54:00 +0000 Subject: [PATCH 70/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 48 files changed, 4879 insertions(+), 4877 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0779e8a..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 = 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 337495a..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-23T02:15:44.496Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 81c621d..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 1a847202b59a041057732e6ca2793c36a6a23572 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 02:42:05 +0000 Subject: [PATCH 71/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 4109502..81c621d 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From dc82d54a28b0579de3c148cd27cf87b612a6595f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 03:37:07 +0000 Subject: [PATCH 72/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b3ed3d7ddc036080e73b8e7b1f339e2a48c5a84f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Mon, 30 Dec 2024 03:37:25 +0000 Subject: [PATCH 73/99] Auto-generated commit --- .editorconfig | 181 - .eslintrc.js | 1 - .gitattributes | 66 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 190 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 106 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 48 files changed, 4879 insertions(+), 4877 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 0779e8a..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 = 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 abb8d67..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2024-12-30T02:25:48.572Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 5f2cda9..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index b369e71..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 755380f..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/math-base-special-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..6bbbd7c --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 81c621d..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-identity": "^0.2.2", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 2317b4a3b236e2e9efe4091cfd5011a2c60c109a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 15 Aug 2025 19:24:28 +0000 Subject: [PATCH 74/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index 28a1ff9..31c3be7 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -90,4 +91,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 15df86619589e67592fdd57e08ded7cc7e2cd6a4 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 15 Aug 2025 19:28:40 +0000 Subject: [PATCH 75/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 6bbbd7c..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2024 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From d5ceb1f6702741ee9f16c7b650e11755db1d9e02 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 15 Aug 2025 19:29:03 +0000 Subject: [PATCH 76/99] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 794 --- .github/workflows/publish.yml | 252 - .github/workflows/test.yml | 99 - .github/workflows/test_bundles.yml | 186 - .github/workflows/test_coverage.yml | 133 - .github/workflows/test_install.yml | 85 - .github/workflows/test_published_package.yml | 105 - .gitignore | 194 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 143 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 67 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 4916 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index f4575e9..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,794 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send status to Slack channel if job fails: - - name: 'Send status to Slack channel in case of failure' - # Pin action to full length commit SHA - uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 - with: - status: ${{ job.status }} - channel: '#npm-ci' - if: failure() - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index a2d6d30..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 47a360e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..dc4b4fc --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 31c3be7..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/number-float64-base-identity": "github:stdlib-js/number-float64-base-identity#main", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.2", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -86,9 +26,8 @@ "map", "transform" ], - "__stdlib__": {}, "funding": { "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 8a3b7253c9f8ece2d3da1298c6ab6dab06b5f0ff Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 30 Jan 2026 22:08:50 +0000 Subject: [PATCH 77/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index eec92d5..4b327be 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/error-tools-fmtprodmsg": "^0.2.2" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -89,4 +90,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From de79d45e2d0daa43fa8fc09fb93369130fd08a09 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 30 Jan 2026 22:19:41 +0000 Subject: [PATCH 78/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index dc4b4fc..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2025 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From b3829b31b4216c95eee88204fff1c74ccd5149ec Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 30 Jan 2026 22:20:03 +0000 Subject: [PATCH 79/99] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 108 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 143 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 5020 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index a2d6d30..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 47a360e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..4af1c82 --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 4b327be..a3b80ad 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.2", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/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-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.2", - "@stdlib/math-base-special-abs": "^0.2.2", - "@stdlib/math-base-special-floor": "^0.2.3", - "@stdlib/math-base-special-pow": "^0.3.0", - "@stdlib/ndarray-base-numel": "^0.2.2", - "@stdlib/number-float64-base-identity": "^0.1.0", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.1", - "@stdlib/utils-nary-function": "^0.2.3", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.2" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -90,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..64e5a7e --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 51bd378b5ddeceb4d91a3f74dfa41075dfc02aef Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 06:50:54 +0000 Subject: [PATCH 80/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index bd7c98b..9dc8584 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.2", @@ -89,4 +90,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From bbc6ebe4f0a887cfbec20afab81323c91a607539 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 07:55:24 +0000 Subject: [PATCH 81/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index 4af1c82..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.1-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 64e5a7e..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e627dc7e8565c8fd6a940efaa3285aad22ca6f5c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 07:55:39 +0000 Subject: [PATCH 82/99] Auto-generated commit --- .editorconfig | 180 - .eslintrc.js | 1 - .gitattributes | 66 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 143 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4879 insertions(+), 5013 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index dab5d2a..0000000 --- a/.editorconfig +++ /dev/null @@ -1,180 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 1c88e69..0000000 --- a/.gitattributes +++ /dev/null @@ -1,66 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index a2d6d30..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 47a360e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d4b08fe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index 9dc8584..1cb94b6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.2", - "@stdlib/array-base-zeros3d": "^0.2.2", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-abs": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/number-float64-base-identity": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.2.1", - "@stdlib/random-base-uniform": "^0.2.2", - "@stdlib/utils-nary-function": "^0.2.4", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -90,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0528cec --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 4de6f5704809586ad4a8b279105240ff3121cbc3 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 08:20:26 +0000 Subject: [PATCH 83/99] Update README.md for ESM bundle v0.2.3 --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4d74caa..dad79c6 100644 --- a/README.md +++ b/README.md @@ -48,13 +48,13 @@ limitations under the License. ## Usage ```javascript -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.3-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-map3d@esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.3-esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +160,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.3-esm/index.mjs'; var shape = [ 3, 3, 3 ]; From f6a6bad39fab5bc1ec4a065b89c35973c2f0f0cb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 8 Feb 2026 08:20:27 +0000 Subject: [PATCH 84/99] Auto-generated commit --- README.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index dad79c6..d97cfbb 100644 --- a/README.md +++ b/README.md @@ -47,6 +47,11 @@ limitations under the License. ## Usage +```javascript +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; +``` +The previous example will load the latest bundled code from the esm branch. Alternatively, you may load a specific version by loading the file from one of the [tagged bundles](https://github.com/stdlib-js/array-base-map3d/tags). For example, + ```javascript import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.3-esm/index.mjs'; ``` @@ -54,7 +59,7 @@ import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.3 You can also import the following named exports from the package: ```javascript -import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.3-esm/index.mjs'; +import { assign } from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; ``` #### map3d( x, shape, fcn\[, thisArg] ) @@ -160,7 +165,7 @@ var discreteUniform = require( 'https://cdn.jsdelivr.net/gh/stdlib-js/random-bas import filled3dBy from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-filled3d-by@esm/index.mjs'; import naryFunction from 'https://cdn.jsdelivr.net/gh/stdlib-js/utils-nary-function@esm/index.mjs'; import abs from 'https://cdn.jsdelivr.net/gh/stdlib-js/math-base-special-abs@esm/index.mjs'; -import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@v0.2.3-esm/index.mjs'; +import map3d from 'https://cdn.jsdelivr.net/gh/stdlib-js/array-base-map3d@esm/index.mjs'; var shape = [ 3, 3, 3 ]; From da21d2e49fd977dc388bcbb1d32559111a8575cb Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Mar 2026 03:39:07 +0000 Subject: [PATCH 85/99] Transform error messages --- package.json | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/package.json b/package.json index a95202e..fe2378c 100644 --- a/package.json +++ b/package.json @@ -38,7 +38,8 @@ }, "dependencies": { "@stdlib/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3" }, "devDependencies": { "@stdlib/array-base-filled3d-by": "^0.2.3", @@ -89,4 +90,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} +} \ No newline at end of file From 649ecce52ddd146afee38a6b0a48be06a374c76e Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Mar 2026 03:54:47 +0000 Subject: [PATCH 86/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d4b08fe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0528cec..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 3bde6012bf81bdb072169b24c73951257a8ab6be Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 29 Mar 2026 03:55:09 +0000 Subject: [PATCH 87/99] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 143 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 117 - benchmark/benchmark.js | 111 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 66 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 48 files changed, 4879 insertions(+), 5025 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 20c3a76..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-03-29T03:31:38.129Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index a2d6d30..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,117 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:assign:size='+numel( sh ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index 47a360e..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,111 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( pkg+'::equidimensional:size='+numel( sh ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d4b08fe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index fe2378c..1cb94b6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.3", - "@stdlib/array-base-zeros3d": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-abs": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/number-float64-base-identity": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.2.2", - "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/utils-nary-function": "^0.2.4", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", @@ -90,4 +30,4 @@ "type": "opencollective", "url": "https://opencollective.com/stdlib" } -} \ No newline at end of file +} diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0528cec --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 53f9a165295628550a2865fb12d0d02732b16312 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 14 Apr 2026 10:17:30 +0000 Subject: [PATCH 88/99] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4451bcd..a5b1712 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "@stdlib/number-float64-base-identity": "^0.1.1", "@stdlib/random-base-discrete-uniform": "^0.2.2", "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/utils-nary-function": "^0.2.4", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", From 3f5c9fe18d9406174d835030023de94abb85c6b8 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 14 Apr 2026 10:28:50 +0000 Subject: [PATCH 89/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d4b08fe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0528cec..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From e23e69f9abb57e340ab7b7d75f1c8e87d87634c1 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Tue, 14 Apr 2026 10:29:10 +0000 Subject: [PATCH 90/99] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 199 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 178 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 118 - benchmark/benchmark.js | 112 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 64 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 47 files changed, 4878 insertions(+), 5060 deletions(-) delete mode 100644 .editorconfig delete mode 100644 .eslintrc.js delete mode 100644 .gitattributes delete mode 100644 .github/PULL_REQUEST_TEMPLATE.md delete mode 100644 .github/workflows/benchmark.yml delete mode 100644 .github/workflows/cancel.yml delete mode 100644 .github/workflows/close_pull_requests.yml delete mode 100644 .github/workflows/examples.yml delete mode 100644 .github/workflows/npm_downloads.yml delete mode 100644 .github/workflows/productionize.yml delete mode 100644 .github/workflows/publish.yml delete mode 100644 .github/workflows/test.yml delete mode 100644 .github/workflows/test_bundles.yml delete mode 100644 .github/workflows/test_coverage.yml delete mode 100644 .github/workflows/test_install.yml delete mode 100644 .github/workflows/test_published_package.yml delete mode 100644 .gitignore delete mode 100644 .npmignore delete mode 100644 .npmrc delete mode 100644 CHANGELOG.md delete mode 100644 CITATION.cff delete mode 100644 CODE_OF_CONDUCT.md delete mode 100644 CONTRIBUTING.md delete mode 100644 Makefile delete mode 100644 SECURITY.md delete mode 100644 benchmark/benchmark.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 78224bb..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,118 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:assign:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ef9bb5d..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,112 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d4b08fe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index a5b1712..1cb94b6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.3", - "@stdlib/array-base-zeros3d": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-abs": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/number-float64-base-identity": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.2.2", - "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/utils-nary-function": "^0.2.4", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0528cec --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 38e249ebce8fa23e68d7a47748613f2fc49e2400 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 May 2026 03:25:03 +0000 Subject: [PATCH 91/99] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 4451bcd..a5b1712 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "@stdlib/number-float64-base-identity": "^0.1.1", "@stdlib/random-base-discrete-uniform": "^0.2.2", "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/utils-nary-function": "^0.2.4", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", From f1aa38229ffece466c2b6c38212203f1c0e7f58a Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 May 2026 03:29:23 +0000 Subject: [PATCH 92/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d4b08fe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0528cec..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 002e0abb2dd31771c618fe29e4298b94344fa6ab Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Wed, 6 May 2026 03:29:39 +0000 Subject: [PATCH 93/99] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 31 - CHANGELOG.md | 178 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 118 - benchmark/benchmark.js | 112 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 64 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 48 files changed, 4878 insertions(+), 5066 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 0087a4d..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-05-06T03:20:44.169Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 78224bb..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,118 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:assign:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ef9bb5d..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,112 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index c648859..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){return r||u((r={exports:{}}).exports,r),r.exports}};var d=p(function(w,y){ -function O(u,r,c,x){var l,e,s,i,a,v,t,n,S,o,f;for(l=r[2],e=r[1],s=r[0],f=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d4b08fe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index a5b1712..1cb94b6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.4.3", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.3", - "@stdlib/array-base-zeros3d": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-abs": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/number-float64-base-identity": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.2.2", - "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/utils-nary-function": "^0.2.4", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0528cec --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 48bec21d84ccdc0f5333a668d097258503d610ed Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 14 Jun 2026 03:34:07 +0000 Subject: [PATCH 94/99] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2e32b99..a6e3644 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "@stdlib/number-float64-base-identity": "^0.1.1", "@stdlib/random-base-discrete-uniform": "^0.2.2", "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/utils-nary-function": "^0.2.4", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", From f095c129b74d8f188ddb57455604f086cc0f63d2 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 14 Jun 2026 03:47:57 +0000 Subject: [PATCH 95/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d4b08fe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0528cec..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 04889536344e9ca05f61724a79495dd1fbc8960f Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 14 Jun 2026 03:48:21 +0000 Subject: [PATCH 96/99] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 178 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 118 - benchmark/benchmark.js | 112 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 64 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 48 files changed, 4878 insertions(+), 5079 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 04fb0cf..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-06-14T03:30:21.367Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 78224bb..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,118 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:assign:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ef9bb5d..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,112 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5b9ffb5..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){try{return r||u((r={exports:{}}).exports,r),r.exports}catch(e){throw (r=0, e)}};};var d=p(function(w,y){ -function O(u,r,e,x){var l,s,n,i,a,v,t,o,S,f,c;for(l=r[2],s=r[1],n=r[0],c=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d4b08fe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index a6e3644..1cb94b6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.5.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.3", - "@stdlib/array-base-zeros3d": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-abs": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/number-float64-base-identity": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.2.2", - "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/utils-nary-function": "^0.2.4", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0528cec --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); From 260dee03c330c3005dff3f24203d3027072d3459 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 31 Jul 2026 03:35:16 +0000 Subject: [PATCH 97/99] Transform error messages --- package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/package.json b/package.json index 2e32b99..a6e3644 100644 --- a/package.json +++ b/package.json @@ -51,7 +51,7 @@ "@stdlib/number-float64-base-identity": "^0.1.1", "@stdlib/random-base-discrete-uniform": "^0.2.2", "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/string-format": "^0.2.3", + "@stdlib/error-tools-fmtprodmsg": "^0.2.3", "@stdlib/utils-nary-function": "^0.2.4", "tape": "git+https://github.com/kgryte/tape.git#fix/globby", "istanbul": "^0.4.1", From 7d91aef7563abd3330f9bc9dfdb6235be8fc9664 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 31 Jul 2026 03:58:10 +0000 Subject: [PATCH 98/99] Remove files --- index.d.ts | 186 -- index.mjs | 4 - index.mjs.map | 1 - stats.html | 4842 ------------------------------------------------- 4 files changed, 5033 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 13202f5..0000000 --- a/index.d.ts +++ /dev/null @@ -1,186 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 { Array3D } from '@stdlib/types/array'; -import { Shape3D } from '@stdlib/types/ndarray'; - -/** -* Array element indices. -*/ -type Indices = [ number, number, number ]; - -/** -* Callback invoked for each array element. -* -* @returns result -*/ -type Nullary = ( this: V ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @returns result -*/ -type Unary = ( this: V, value: T ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @returns result -*/ -type Binary = ( this: V, value: T, indices: Indices ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Ternary = ( this: V, value: T, indices: Indices, array: Array3D ) => U; - -/** -* Callback invoked for each array element. -* -* @param value - array element -* @param indices - current array element indices -* @param array - input array -* @returns result -*/ -type Callback = Nullary | Unary | Binary | Ternary; - -/** -* Interface describing the main export. -*/ -interface Routine { - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. - * - * @param x - input nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = map3d( x, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - */ - ( x: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; - - /** - * Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. - * - * @param x - input nested array - * @param y - output nested array - * @param shape - array shape - * @param fcn - function to apply - * @param thisArg - function execution context - * - * @example - * var ones3d = require( '@stdlib/array-base-ones3d' ); - * var zeros3d = require( '@stdlib/array-base-zeros3d' ); - * - * function scale( x ) { - * return x * 10.0; - * } - * - * var shape = [ 1, 2, 2 ]; - * - * var x = ones3d( shape ); - * var y = zeros3d( shape ); - * - * var out = map3d.assign( x, y, shape, scale ); - * // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] - * - * var bool = ( out === y ); - * // returns true - */ - assign( x: Array3D, y: Array3D, shape: Shape3D, fcn: Callback, thisArg?: ThisParameterType> ): Array3D; -} - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* ## Notes -* -* - The applied function is provided the following arguments: -* -* - **value**: array element. -* - **indices**: current array element indices. -* -- **array**: input nested array. -* -* @param x - input nested array -* @param shape - array shape -* @param fcn - function to apply -* @param thisArg - function execution context -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -declare var map3d: Routine; - - -// EXPORTS // - -export = map3d; diff --git a/index.mjs b/index.mjs deleted file mode 100644 index d4b08fe..0000000 --- a/index.mjs +++ /dev/null @@ -1,4 +0,0 @@ -// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 -/// -import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/stats.html b/stats.html deleted file mode 100644 index 0528cec..0000000 --- a/stats.html +++ /dev/null @@ -1,4842 +0,0 @@ - - - - - - - - Rollup Visualizer - - - -
- - - - - From 36c436469bc0746ca230e344886798d95538a725 Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Fri, 31 Jul 2026 03:58:30 +0000 Subject: [PATCH 99/99] Auto-generated commit --- .editorconfig | 189 - .eslintrc.js | 1 - .gitattributes | 68 - .github/.keepalive | 1 - .github/PULL_REQUEST_TEMPLATE.md | 7 - .github/workflows/benchmark.yml | 64 - .github/workflows/cancel.yml | 57 - .github/workflows/close_pull_requests.yml | 54 - .github/workflows/examples.yml | 64 - .github/workflows/npm_downloads.yml | 112 - .github/workflows/productionize.yml | 821 --- .github/workflows/publish.yml | 261 - .github/workflows/test.yml | 101 - .github/workflows/test_bundles.yml | 213 - .github/workflows/test_coverage.yml | 142 - .github/workflows/test_install.yml | 94 - .github/workflows/test_published_package.yml | 115 - .gitignore | 204 - .npmignore | 229 - .npmrc | 44 - CHANGELOG.md | 178 - CITATION.cff | 30 - CODE_OF_CONDUCT.md | 3 - CONTRIBUTING.md | 3 - Makefile | 534 -- README.md | 59 +- SECURITY.md | 5 - benchmark/benchmark.assign.js | 118 - benchmark/benchmark.js | 112 - branches.md | 56 - dist/index.d.ts | 3 - dist/index.js | 7 - dist/index.js.map | 7 - docs/repl.txt | 71 - docs/types/test.ts | 227 - examples/index.js | 33 - docs/types/index.d.ts => index.d.ts | 2 +- index.mjs | 4 + index.mjs.map | 1 + lib/assign.js | 91 - lib/index.js | 75 - lib/main.js | 81 - package.json | 64 +- stats.html | 4842 ++++++++++++++++++ test/dist/test.js | 33 - test/test.assign.js | 227 - test/test.js | 38 - test/test.main.js | 212 - 48 files changed, 4878 insertions(+), 5079 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.assign.js delete mode 100644 benchmark/benchmark.js delete mode 100644 branches.md delete mode 100644 dist/index.d.ts delete mode 100644 dist/index.js delete mode 100644 dist/index.js.map delete mode 100644 docs/repl.txt delete mode 100644 docs/types/test.ts delete mode 100644 examples/index.js rename docs/types/index.d.ts => index.d.ts (98%) create mode 100644 index.mjs create mode 100644 index.mjs.map delete mode 100644 lib/assign.js delete mode 100644 lib/index.js delete mode 100644 lib/main.js create mode 100644 stats.html delete mode 100644 test/dist/test.js delete mode 100644 test/test.assign.js delete mode 100644 test/test.js delete mode 100644 test/test.main.js diff --git a/.editorconfig b/.editorconfig deleted file mode 100644 index 80f3fca..0000000 --- a/.editorconfig +++ /dev/null @@ -1,189 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# EditorConfig configuration file (see ). - -# Indicate that this file is a root-level configuration file: -root = true - -# Set properties for all files: -[*] -end_of_line = lf -charset = utf-8 -trim_trailing_whitespace = true -insert_final_newline = true - -# Set properties for JavaScript files: -[*.{js,js.txt}] -indent_style = tab - -# Set properties for JavaScript ES module files: -[*.{mjs,mjs.txt}] -indent_style = tab - -# Set properties for JavaScript CommonJS files: -[*.{cjs,cjs.txt}] -indent_style = tab - -# Set properties for JSON files: -[*.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `cli_opts.json` files: -[cli_opts.json] -indent_style = tab - -# Set properties for TypeScript files: -[*.ts] -indent_style = tab - -# Set properties for Python files: -[*.{py,py.txt}] -indent_style = space -indent_size = 4 - -# Set properties for Julia files: -[*.{jl,jl.txt}] -indent_style = tab - -# Set properties for R files: -[*.{R,R.txt}] -indent_style = tab - -# Set properties for C files: -[*.{c,c.txt}] -indent_style = tab - -# Set properties for C header files: -[*.{h,h.txt}] -indent_style = tab - -# Set properties for C++ files: -[*.{cpp,cpp.txt}] -indent_style = tab - -# Set properties for C++ header files: -[*.{hpp,hpp.txt}] -indent_style = tab - -# Set properties for Fortran files: -[*.{f,f.txt}] -indent_style = space -indent_size = 2 - -# Set properties for shell files: -[*.{sh,sh.txt}] -indent_style = tab - -# Set properties for AWK files: -[*.{awk,awk.txt}] -indent_style = tab - -# Set properties for HTML files: -[*.{html,html.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for XML files: -[*.{xml,xml.txt}] -indent_style = tab -tab_width = 2 - -# Set properties for CSS files: -[*.{css,css.txt}] -indent_style = tab - -# Set properties for Makefiles: -[Makefile] -indent_style = tab - -[*.{mk,mk.txt}] -indent_style = tab - -# Set properties for Markdown files: -[*.{md,md.txt}] -indent_style = space -indent_size = 4 -trim_trailing_whitespace = true # Note: this disables using two spaces to force a hard line break, which is permitted in Markdown. As we don't typically follow that practice (TMK), we should be safe to automatically trim. - -# Set properties for `usage.txt` files: -[usage.txt] -indent_style = space -indent_size = 2 - -# Set properties for `repl.txt` files: -[repl.txt] -indent_style = space -indent_size = 4 - -# Set properties for `package.json` files: -[package.{json,json.txt}] -indent_style = space -indent_size = 2 - -# Set properties for `datapackage.json` files: -[datapackage.json] -indent_style = space -indent_size = 2 - -# Set properties for `manifest.json` files: -[manifest.json] -indent_style = space -indent_size = 2 - -# Set properties for `tsconfig.json` files: -[tsconfig.json] -indent_style = space -indent_size = 2 - -# Set properties for LaTeX files: -[*.{tex,tex.txt}] -indent_style = tab - -# Set properties for LaTeX Bibliography files: -[*.{bib,bib.txt}] -indent_style = tab - -# Set properties for YAML files: -[*.{yml,yml.txt}] -indent_style = space -indent_size = 2 - -# Ignore generated lock files for GitHub Agentic Workflows: -[*.lock.yml] -charset = unset -end_of_line = unset -indent_style = unset -indent_size = unset -trim_trailing_whitespace = unset -insert_final_newline = unset - -# Set properties for GYP files: -[binding.gyp] -indent_style = space -indent_size = 2 - -[*.gypi] -indent_style = space -indent_size = 2 - -# Set properties for citation files: -[*.{cff,cff.txt}] -indent_style = space -indent_size = 2 diff --git a/.eslintrc.js b/.eslintrc.js deleted file mode 100644 index 5f30286..0000000 --- a/.eslintrc.js +++ /dev/null @@ -1 +0,0 @@ -/* For the `eslint` rules of this project, consult the main repository at https://github.com/stdlib-js/stdlib */ diff --git a/.gitattributes b/.gitattributes deleted file mode 100644 index 24b327f..0000000 --- a/.gitattributes +++ /dev/null @@ -1,68 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2017 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Configuration file which assigns attributes to pathnames. -# -# [1]: https://git-scm.com/docs/gitattributes - -# Automatically normalize the line endings of any committed text files: -* text=auto - -# Override line endings for certain files on checkout: -*.crlf.csv text eol=crlf - -# Denote that certain files are binary and should not be modified: -*.png binary -*.jpg binary -*.jpeg binary -*.gif binary -*.ico binary -*.gz binary -*.zip binary -*.7z binary -*.mp3 binary -*.mp4 binary -*.mov binary - -# Override what is considered "vendored" by GitHub's linguist: -/lib/node_modules/** -linguist-vendored -linguist-generated - -# Configure directories which should *not* be included in GitHub language statistics: -/deps/** linguist-vendored -/dist/** linguist-generated -/workshops/** linguist-vendored - -benchmark/** linguist-vendored -docs/* linguist-documentation -etc/** linguist-vendored -examples/** linguist-documentation -scripts/** linguist-vendored -test/** linguist-vendored -tools/** linguist-vendored - -# Configure files which should *not* be included in GitHub language statistics: -Makefile linguist-vendored -*.mk linguist-vendored -*.jl linguist-vendored -*.py linguist-vendored -*.R linguist-vendored - -# Configure files which should be included in GitHub language statistics: -docs/types/*.d.ts -linguist-documentation - -.github/workflows/*.lock.yml linguist-generated=true merge=ours diff --git a/.github/.keepalive b/.github/.keepalive deleted file mode 100644 index 74ba26f..0000000 --- a/.github/.keepalive +++ /dev/null @@ -1 +0,0 @@ -2026-07-31T03:25:33.796Z diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index afb2264..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/map3d) 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 ec11a22..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/map3d) 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 da2a0be..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: '30 6 * * 6' - - # Allow the workflow to be manually run: - workflow_dispatch: - -# Workflow jobs: -jobs: - - # Define a job for retrieving npm download counts... - npm_downloads: - - # Define display name: - name: 'Retrieve npm download counts' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - timeout-minutes: 10 - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Resolve package name: - - name: 'Resolve package name' - id: package_name - run: | - name=`node -e 'console.log(require("./package.json").name)' | tr -d '\n'` - echo "package_name=$name" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Fetch download data: - - name: 'Fetch data' - id: download_data - run: | - url="https://api.npmjs.org/downloads/range/$(date --date='1 year ago' '+%Y-%m-%d'):$(date '+%Y-%m-%d')/${{ steps.package_name.outputs.package_name }}" - echo "$url" - data=$(curl "$url") - mkdir ./tmp - echo "$data" > ./tmp/npm_downloads.json - echo "data=$data" >> $GITHUB_OUTPUT - timeout-minutes: 5 - - # Print summary of download data: - - name: 'Print summary' - run: | - echo "| Date | Downloads |" >> $GITHUB_STEP_SUMMARY - echo "|------|------------|" >> $GITHUB_STEP_SUMMARY - cat ./tmp/npm_downloads.json | jq -r ".downloads | .[-14:] | to_entries | map(\"| \(.value.day) | \(.value.downloads) |\") |.[]" >> $GITHUB_STEP_SUMMARY - - # Upload the download data: - - name: 'Upload data' - # Pin action to full length commit SHA - uses: actions/upload-artifact@5d5d22a31266ced268874388b861e4b58bb5c2f3 # v4.3.1 - with: - # Define a name for the uploaded artifact (ensuring a unique name for each job): - name: npm_downloads - - # Specify the path to the file to upload: - path: ./tmp/npm_downloads.json - - # Specify the number of days to retain the artifact (default is 90 days): - retention-days: 90 - timeout-minutes: 10 - if: success() - - # Send data to events server: - - name: 'Post data' - # Pin action to full length commit SHA - uses: distributhor/workflow-webhook@48a40b380ce4593b6a6676528cd005986ae56629 # v3.0.3 - env: - webhook_url: ${{ secrets.STDLIB_NPM_DOWNLOADS_URL }} - webhook_secret: ${{ secrets.STDLIB_WEBHOOK_SECRET }} - data: '{ "downloads": ${{ steps.download_data.outputs.data }} }' - timeout-minutes: 5 - if: success() diff --git a/.github/workflows/productionize.yml b/.github/workflows/productionize.yml deleted file mode 100644 index 83d50c4..0000000 --- a/.github/workflows/productionize.yml +++ /dev/null @@ -1,821 +0,0 @@ -#/ -# @license Apache-2.0 -# -# Copyright (c) 2022 The Stdlib Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. -#/ - -# Workflow name: -name: productionize - -# Workflow triggers: -on: - # Run workflow when a new commit is pushed to the main branch: - push: - branches: - - main - - # Allow the workflow to be manually run: - workflow_dispatch: - inputs: - require-passing-tests: - description: 'Require passing tests for creating bundles' - type: boolean - default: true - - # Run workflow upon completion of `publish` workflow run: - workflow_run: - workflows: ["publish"] - types: [completed] - - -# Concurrency group to prevent multiple concurrent executions: -concurrency: - group: productionize - cancel-in-progress: true - -# Workflow jobs: -jobs: - - # Define a job to create a production build... - productionize: - - # Define display name: - name: 'Productionize' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Define the sequence of job steps... - steps: - # Checkout main branch of repository: - - name: 'Checkout main branch' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - ref: main - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Create production branch: - - name: 'Create production branch' - run: | - git checkout -b production - - # Transform error messages: - - name: 'Transform error messages' - id: transform-error-messages - uses: stdlib-js/transform-errors-action@main - - # Change `@stdlib/string-format` to `@stdlib/error-tools-fmtprodmsg` in package.json if the former is a dependency, otherwise insert it as a dependency: - - name: 'Update dependencies in package.json' - run: | - PKG_VERSION=$(npm view @stdlib/error-tools-fmtprodmsg version) - if grep -q '"@stdlib/string-format"' package.json; then - sed -i "s/\"@stdlib\/string-format\": \"^.*\"/\"@stdlib\/error-tools-fmtprodmsg\": \"^$PKG_VERSION\"/g" package.json - else - node -e "var pkg = require( './package.json' ); pkg.dependencies[ '@stdlib/error-tools-fmtprodmsg' ] = '^$PKG_VERSION'; require( 'fs' ).writeFileSync( 'package.json', JSON.stringify( pkg, null, 2 ) );" - fi - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Transform error messages" - - # Push changes: - - name: 'Push changes' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" production --force - - # Define a job for running tests of the productionized code... - test: - - # Define a display name: - name: 'Run Tests' - - # Define the type of virtual host machine: - runs-on: 'ubuntu-latest' - - # Indicate that this job depends on the prior job finishing: - needs: productionize - - # Run this job regardless of the outcome of the prior job: - if: always() - - # Define the sequence of job steps... - steps: - - # Checkout the repository: - - name: 'Checkout repository' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - with: - # Use the `production` branch: - ref: production - - # Install Node.js: - - name: 'Install Node.js' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Build native add-on if present: - - name: 'Build native add-on (if present)' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - run: | - if [ -f "binding.gyp" ]; then - npm install node-gyp --no-save && ./node_modules/.bin/node-gyp rebuild - fi - - # Run tests: - - name: 'Run tests' - if: ${{ github.event.inputs.require-passing-tests == 'true' }} - id: tests - run: | - npm test || npm test || npm test - - # Define job to create a bundle for use in Deno... - deno: - - # Define display name: - name: 'Create Deno bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `deno` branch exists: - - name: 'Check if remote `deno` branch exists' - id: deno-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin deno - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `deno` exists, delete everything in branch and merge `production` into it - - name: 'If `deno` exists, delete everything in branch and merge `production` into it' - if: steps.deno-branch-exists.outputs.remote-exists - run: | - git checkout -b deno origin/deno - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `deno` does not exist, create `deno` branch: - - name: 'If `deno` does not exist, create `deno` branch' - if: ${{ steps.deno-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b deno - - # Copy files to deno directory: - - name: 'Copy files to deno directory' - run: | - mkdir -p deno - cp README.md LICENSE CONTRIBUTORS NOTICE ./deno - - # Copy TypeScript definitions to deno directory: - if [ -d index.d.ts ]; then - cp index.d.ts ./deno/index.d.ts - fi - if [ -e ./docs/types/index.d.ts ]; then - cp ./docs/types/index.d.ts ./deno/mod.d.ts - fi - - # Install Node.js: - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: Install production and development dependencies - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Bundle package for use in Deno: - - name: 'Bundle package for Deno' - id: deno-bundle - uses: stdlib-js/bundle-action@main - with: - target: 'deno' - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - # Replace links to other packages with links to the deno branch: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/deno/"; - - # Replace reference to `@stdlib/types` with CDN link: - find ./deno -type f -name '*.ts' -print0 | xargs -0 -r sed -Ei "s/\/\/\/ /\/\/\/ /g" - - # Change wording of project description to avoid reference to JavaScript and Node.js: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/a standard library for JavaScript and Node.js, /a standard library /g" - - # Rewrite all `require()`s to use jsDelivr links: - find ./deno -type f -name '*.md' -print0 | xargs -0 sed -Ei "/require\( '@stdlib\// { - s/(var|let|const)\s+([a-z0-9_]+)\s+=\s*require\( '([^']+)' \);/import \2 from \'\3\';/i - s/@stdlib/https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js/ - s/';/@deno\/mod.js';/ - }" - - # Rewrite first `import` to show importing of named exports if available: - exports=$(cat lib/index.js | \ - grep -E 'setReadOnly\(.*,.*,.*\)' | \ - sed -E 's/setReadOnly\((.*),(.*),(.*)\);/\2/' | \ - sed -E "s/'//g" | \ - sort) - if [ -n "$exports" ]; then - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\nimport\s+([a-zA-Z0-9_]+)\s+from\s*'([^']+)';\n\`\`\`/\`\`\`javascript\nimport \1 from '\2';\n\`\`\`\n\nYou can also import the following named exports from the package:\n\n\`\`\`javascript\nimport { $(echo $exports | sed -E 's/ /, /g') } from '\2';\n\`\`\`/" - fi - - # Remove `installation`, `cli`, and `c` sections: - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./deno -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Create package.json file for deno branch: - jq --indent 2 '{"name": .name, "version": .version, "description": .description, "license": .license, "type": "module", "main": "./mod.js", "homepage": .homepage, "repository": .repository, "bugs": .bugs, "keywords": .keywords, "funding": .funding}' package.json > ./deno/package.json - - # Delete everything in current directory aside from deno folder: - - name: 'Delete everything in current directory aside from deno folder' - run: | - find . -type 'f' | grep -v -e "deno" -e ".git/" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e "deno" -e ".git" | xargs -r rm -rf - - # Move deno directory to root: - - name: 'Move deno directory to root' - run: | - mv ./deno/* . - rmdir ./deno - - # Commit changes: - - name: 'Commit changes' - run: | - git add -A - git commit -m "Auto-generated commit" - - # Push changes to `deno` branch: - - name: 'Push changes to `deno` branch' - run: | - SLUG=${{ github.repository }} - echo "Pushing changes to $SLUG..." - git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" deno - - # Send notification to Zulip if job fails: - - name: 'Send notification to Zulip in case of failure' - # Pin action to full length commit SHA - uses: zulip/github-actions-zulip/send-message@e4c8f27c732ba9bd98ac6be0583096dea82feea5 # v1.0.2 - if: failure() - with: - api-key: ${{ secrets.ZULIP_API_KEY }} - email: 'github-actions-bot@stdlib.zulipchat.com' - organization-url: 'https://stdlib.zulipchat.com' - to: 'workflows-standalone' - type: 'stream' - topic: ${{ github.event.repository.name }} - content: | - :cross_mark: **${{ github.workflow }}** workflow failed - - **Repository:** [${{ github.repository }}](${{ github.server_url }}/${{ github.repository }}) - **Run:** [View workflow run](${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}) - - # Define job to create a UMD bundle... - umd: - - # Define display name: - name: 'Create UMD bundle' - - # Define the type of virtual host machine on which to run the job: - runs-on: ubuntu-latest - - # Indicate that this job depends on the test job finishing: - needs: test - - # Define the sequence of job steps... - steps: - # Checkout the repository: - - name: 'Checkout repository' - # Pin action to full length commit SHA - uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - - # Configure Git: - - name: 'Configure Git' - run: | - git config --local user.email "noreply@stdlib.io" - git config --local user.name "stdlib-bot" - - # Check if remote `umd` branch exists: - - name: 'Check if remote `umd` branch exists' - id: umd-branch-exists - continue-on-error: true - run: | - git fetch --all - git ls-remote --exit-code --heads origin umd - if [ $? -eq 0 ]; then - echo "remote-exists=true" >> $GITHUB_OUTPUT - else - echo "remote-exists=false" >> $GITHUB_OUTPUT - fi - - # If `umd` exists, delete everything in branch and merge `production` into it - - name: 'If `umd` exists, delete everything in branch and merge `production` into it' - if: steps.umd-branch-exists.outputs.remote-exists - run: | - git checkout -b umd origin/umd - - find . -type 'f' | grep -v -e ".git/" -e "package.json" -e "README.md" -e "LICENSE" -e "CONTRIBUTORS" -e "NOTICE" | xargs -r rm - find . -mindepth 1 -type 'd' | grep -v -e ".git" | xargs -r rm -rf - - git add -A - git commit -m "Remove files" --allow-empty - - git config merge.theirs.name 'simulate `-s theirs`' - git config merge.theirs.driver 'cat %B > %A' - GIT_CONFIG_PARAMETERS="'merge.default=theirs'" git merge origin/production --allow-unrelated-histories - - # Copy files from `production` branch if necessary: - git checkout origin/production -- . - if [ -n "$(git status --porcelain)" ]; then - git add -A - git commit -m "Auto-generated commit" - fi - - # If `umd` does not exist, create `umd` branch: - - name: 'If `umd` does not exist, create `umd` branch' - if: ${{ steps.umd-branch-exists.outputs.remote-exists == false }} - run: | - git checkout production - git checkout -b umd - - # Copy files to umd directory: - - name: 'Copy files to umd directory' - run: | - mkdir -p umd - cp README.md LICENSE CONTRIBUTORS NOTICE ./umd - - # Install Node.js - - name: 'Install Node.js' - # Pin action to full length commit SHA - uses: actions/setup-node@b39b52d1213e96004bfcb1c61a8a6fa8ab84f3e8 # v4.0.1 - with: - node-version: 20 - timeout-minutes: 5 - - # Install dependencies: - - name: 'Install production and development dependencies' - id: install - run: | - npm install || npm install || npm install - timeout-minutes: 15 - - # Extract alias: - - name: 'Extract alias' - id: extract-alias - run: | - alias=$(grep -E 'require\(' README.md | head -n 1 | sed -E 's/^var ([a-zA-Z0-9_]+) = .+/\1/') - echo "alias=${alias}" >> $GITHUB_OUTPUT - - # Create Universal Module Definition (UMD) Node.js bundle: - - name: 'Create Universal Module Definition (UMD) Node.js bundle' - id: umd-bundle-node - uses: stdlib-js/bundle-action@main - with: - target: 'umd-node' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Create Universal Module Definition (UMD) browser bundle: - - name: 'Create Universal Module Definition (UMD) browser bundle' - id: umd-bundle-browser - uses: stdlib-js/bundle-action@main - with: - target: 'umd-browser' - alias: ${{ steps.extract-alias.outputs.alias }} - - # Rewrite file contents: - - name: 'Rewrite file contents' - run: | - - # Replace links to other packages with links to the umd branch: - find ./umd -type f -name '*.md' -print0 | xargs -0 sed -Ei "/\/tree\/main/b; /^\[@stdlib[^:]+: https:\/\/github.com\/stdlib-js\// s/(.*)/\\1\/tree\/umd/"; - - # Remove `installation`, `cli`, and `c` sections: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/
[^<]+<\/section>//g;" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.cli \-\->//g" - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/(\* \* \*\n+)?
[\s\S]+<\!\-\- \/.c \-\->//g" - - # Rewrite first `require()` to show consumption of the UMD bundle in Observable and via a `script` tag: - find ./umd -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe "s/\`\`\`javascript\n(var|let|const)\s+([a-zA-Z0-9_]+)\s+=\s*require\( '\@stdlib\/([^']+)' \);\n\`\`\`/To use in Observable,\n\n\`\`\`javascript\n\2 = require\( 'https:\/\/cdn.jsdelivr.net\/gh\/stdlib-js\/\3\@umd\/browser.js' \)\n\`\`\`\n\nTo vendor stdlib functionality and avoid installing dependency trees for Node.js, you can use the UMD server build:\n\n\`\`\`javascript\nvar \2 = require\( 'path\/to\/vendor\/umd\/\3\/index.js' \)\n\`\`\`\n\nTo include the bundle in a webpage,\n\n\`\`\`html\n + + ```
@@ -199,7 +196,7 @@ console.log( y ); ## 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.assign.js b/benchmark/benchmark.assign.js deleted file mode 100644 index 78224bb..0000000 --- a/benchmark/benchmark.assign.js +++ /dev/null @@ -1,118 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ).assign; - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x; - var y; - - x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - y = zeros3d( shape ); - - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, y, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:assign:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js deleted file mode 100644 index ef9bb5d..0000000 --- a/benchmark/benchmark.js +++ /dev/null @@ -1,112 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 uniform = require( '@stdlib/random-base-uniform' ).factory; -var isnan = require( '@stdlib/math-base-assert-is-nan' ); -var pow = require( '@stdlib/math-base-special-pow' ); -var floor = require( '@stdlib/math-base-special-floor' ); -var identity = require( '@stdlib/number-float64-base-identity' ); -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var format = require( '@stdlib/string-format' ); -var pkg = require( './../package.json' ).name; -var map3d = require( './../lib' ); - - -// FUNCTIONS // - -/** -* Creates a benchmark function. -* -* @private -* @param {PositiveIntegerArray} shape - array shape -* @returns {Function} benchmark function -*/ -function createBenchmark( shape ) { - var x = filled3dBy( shape, uniform( -100.0, 100.0 ) ); - return benchmark; - - /** - * Benchmark function. - * - * @private - * @param {Benchmark} b - benchmark instance - */ - function benchmark( b ) { - var out; - var i0; - var i1; - var i2; - var i; - - b.tic(); - for ( i = 0; i < b.iterations; i++ ) { - out = map3d( x, shape, identity ); - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - } - b.toc(); - - i2 = i % shape[ 0 ]; - i1 = i % shape[ 1 ]; - i0 = i % shape[ 2 ]; - if ( isnan( out[ i2 ][ i1 ][ i0 ] ) ) { - b.fail( 'should not return NaN' ); - } - b.pass( 'benchmark finished' ); - b.end(); - } -} - - -// MAIN // - -/** -* Main execution sequence. -* -* @private -*/ -function main() { - var min; - var max; - var sh; - var N; - var f; - var i; - - min = 1; // 10^min - max = 6; // 10^max - - for ( i = min; i <= max; i++ ) { - N = floor( pow( pow( 10, i ), 1.0/3.0 ) ); - sh = [ N, N, N ]; - f = createBenchmark( sh ); - bench( format( '%s::equidimensional:size=%d', pkg, numel( sh ) ), f ); - } -} - -main(); diff --git a/branches.md b/branches.md deleted file mode 100644 index 76b762a..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/map3d" -%% click B href "https://github.com/stdlib-js/array-base-map3d/tree/main" -%% click C href "https://github.com/stdlib-js/array-base-map3d/tree/production" -%% click D href "https://github.com/stdlib-js/array-base-map3d/tree/esm" -%% click E href "https://github.com/stdlib-js/array-base-map3d/tree/deno" -%% click F href "https://github.com/stdlib-js/array-base-map3d/tree/umd" -``` - -[stdlib-url]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/base/map3d -[production-url]: https://github.com/stdlib-js/array-base-map3d/tree/production -[deno-url]: https://github.com/stdlib-js/array-base-map3d/tree/deno -[deno-readme]: https://github.com/stdlib-js/array-base-map3d/blob/deno/README.md -[umd-url]: https://github.com/stdlib-js/array-base-map3d/tree/umd -[umd-readme]: https://github.com/stdlib-js/array-base-map3d/blob/umd/README.md -[esm-url]: https://github.com/stdlib-js/array-base-map3d/tree/esm -[esm-readme]: https://github.com/stdlib-js/array-base-map3d/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 3e76d05..0000000 --- a/dist/index.d.ts +++ /dev/null @@ -1,3 +0,0 @@ -/// -import map3d from '../docs/types/index'; -export = map3d; \ No newline at end of file diff --git a/dist/index.js b/dist/index.js deleted file mode 100644 index 5b9ffb5..0000000 --- a/dist/index.js +++ /dev/null @@ -1,7 +0,0 @@ -"use strict";var p=function(u,r){return function(){try{return r||u((r={exports:{}}).exports,r),r.exports}catch(e){throw (r=0, e)}};};var d=p(function(w,y){ -function O(u,r,e,x){var l,s,n,i,a,v,t,o,S,f,c;for(l=r[2],s=r[1],n=r[0],c=[],v=0;v} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nmodule.exports = map3d;\n", "/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* var ones3d = require( '@stdlib/array-base-ones3d' );\n* var zeros3d = require( '@stdlib/array-base-zeros3d' );\n* var map3d = require( '@stdlib/array-base-map3d' );\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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": "iIAAA,IAAAA,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cA4CA,SAASC,EAAOC,EAAGC,EAAOC,EAAKC,EAAU,CACxC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACda,EAAI,CAAC,EACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,CAAG,EACXI,EAAK,CAAC,EACAL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAK,CAAC,EACAJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAG,KAAMT,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGP,CAAE,CAAE,EAE3Da,EAAG,KAAMF,CAAG,CACb,CACAG,EAAE,KAAMD,CAAG,CACZ,CACA,OAAOC,CACR,CAKAhB,EAAO,QAAUC,IChFjB,IAAAgB,EAAAC,EAAA,SAAAC,EAAAC,EAAA,cAuDA,SAASC,EAAOC,EAAGC,EAAGC,EAAOC,EAAKC,EAAU,CAC3C,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,CAAE,EACdI,EAAKJ,EAAO,CAAE,EACdK,EAAKL,EAAO,CAAE,EACTG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAON,EAER,IAAMS,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKb,EAAGU,CAAG,EACXI,EAAKb,EAAGS,CAAG,EACLD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,CAAG,EACZG,EAAKE,EAAIL,CAAG,EACND,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,CAAG,EAAIL,EAAI,KAAMC,EAASO,EAAIH,CAAG,EAAG,CAAEE,EAAID,EAAID,CAAG,EAAGR,CAAE,EAI7D,OAAOC,CACR,CAKAH,EAAO,QAAUC,IC5BjB,IAAIgB,EAAc,QAAS,uDAAwD,EAC/EC,EAAO,IACPC,EAAS,IAKbF,EAAaC,EAAM,SAAUC,CAAO,EAKpC,OAAO,QAAUD", - "names": ["require_main", "__commonJSMin", "exports", "module", "map3d", "x", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "y", "require_assign", "__commonJSMin", "exports", "module", "map3d", "x", "y", "shape", "fcn", "thisArg", "S0", "S1", "S2", "i0", "i1", "i2", "x0", "y0", "x1", "y1", "setReadOnly", "main", "assign"] -} diff --git a/docs/repl.txt b/docs/repl.txt deleted file mode 100644 index 8812b2d..0000000 --- a/docs/repl.txt +++ /dev/null @@ -1,71 +0,0 @@ - -{{alias}}( x, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a new three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: Array - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var y = {{alias}}( x, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - - -{{alias}}.assign( x, y, shape, fcn[, thisArg] ) - Applies a function to elements in a three-dimensional nested input array and - assigns results to elements in a three-dimensional nested output array. - - Parameters - ---------- - x: ArrayLikeObject - Input nested array. - - y: ArrayLikeObject - Output nested array. - - shape: Array - Array shape. - - fcn: Function - Function to apply. - - thisArg: any (optional) - Function execution context. - - Returns - ------- - out: ArrayLikeObject - Output nested array. - - Examples - -------- - > var x = [ [ [ -1.0, -2.0 ], [ -3.0, -4.0 ] ] ]; - > var y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - > var shape = [ 1, 2, 2 ]; - > var out = {{alias}}.assign( x, y, shape, {{alias:@stdlib/math/base/special/abs}} ) - [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ] - > var b = ( out === y ) - true - - See Also - -------- - diff --git a/docs/types/test.ts b/docs/types/test.ts deleted file mode 100644 index 8f898c9..0000000 --- a/docs/types/test.ts +++ /dev/null @@ -1,227 +0,0 @@ -/* -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT 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 map3d = require( './index' ); - -/** -* Unary function. -* -* @param value - input value -* @returns result -*/ -function fcn( value: number ): number { - return value; -} - - -// TESTS // - -// The function returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d( x, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the function is provided a first argument which is not a nested array... -{ - map3d( 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d( 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d( ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a second argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, 'abc', fcn ); // $ExpectError - map3d( x, 3.14, fcn ); // $ExpectError - map3d( x, true, fcn ); // $ExpectError - map3d( x, false, fcn ); // $ExpectError - map3d( x, null, fcn ); // $ExpectError - map3d( x, [ '1' ], fcn ); // $ExpectError - map3d( x, {}, fcn ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn ); // $ExpectError - - map3d( x, 'abc', fcn, {} ); // $ExpectError - map3d( x, 3.14, fcn, {} ); // $ExpectError - map3d( x, true, fcn, {} ); // $ExpectError - map3d( x, false, fcn, {} ); // $ExpectError - map3d( x, null, fcn, {} ); // $ExpectError - map3d( x, [ '1' ], fcn, {} ); // $ExpectError - map3d( x, {}, fcn, {} ); // $ExpectError - map3d( x, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided a third argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d( x, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d( x, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d( x, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the function is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d(); // $ExpectError - map3d( x ); // $ExpectError - map3d( x, [ 1, 2, 2 ] ); // $ExpectError - map3d( x, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} - -// Attached to the main export is an `assign` method which returns a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], fcn ); // $ExpectType Array3D - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectType Array3D -} - -// The compiler throws an error if the `assign` method is provided a first argument which is not a nested array... -{ - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( 'abc', y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( 3.14, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( true, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( false, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( null, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( [ '1' ], y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( {}, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( ( x: number ): number => x, y, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a second argument which is not a nested array... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn ); // $ExpectError - - map3d.assign( x, 'abc', [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, 3.14, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, true, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, false, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, null, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, [ '1' ], [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, {}, [ 1, 2, 2 ], fcn, {} ); // $ExpectError - map3d.assign( x, ( x: number ): number => x, [ 1, 2, 2 ], fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a third argument which is not an array of numbers... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, 'abc', fcn ); // $ExpectError - map3d.assign( x, y, 3.14, fcn ); // $ExpectError - map3d.assign( x, y, true, fcn ); // $ExpectError - map3d.assign( x, y, false, fcn ); // $ExpectError - map3d.assign( x, y, null, fcn ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn ); // $ExpectError - map3d.assign( x, y, {}, fcn ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn ); // $ExpectError - - map3d.assign( x, y, 'abc', fcn, {} ); // $ExpectError - map3d.assign( x, y, 3.14, fcn, {} ); // $ExpectError - map3d.assign( x, y, true, fcn, {} ); // $ExpectError - map3d.assign( x, y, false, fcn, {} ); // $ExpectError - map3d.assign( x, y, null, fcn, {} ); // $ExpectError - map3d.assign( x, y, [ '1' ], fcn, {} ); // $ExpectError - map3d.assign( x, y, {}, fcn, {} ); // $ExpectError - map3d.assign( x, y, ( x: number ): number => x, fcn, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided a fourth argument which is not a valid callback... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc' ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14 ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {} ); // $ExpectError - - map3d.assign( x, y, [ 1, 2, 2 ], 'abc', {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], 3.14, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], true, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], false, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], null, {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], [ '1' ], {} ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], {}, {} ); // $ExpectError -} - -// The compiler throws an error if the `assign` method is provided an unsupported number of arguments... -{ - const x = [ [ [ 1.0, 2.0 ], [ 3.0, 4.0 ] ] ]; - const y = [ [ [ 0.0, 0.0 ], [ 0.0, 0.0 ] ] ]; - - map3d.assign(); // $ExpectError - map3d.assign( x, y ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ] ); // $ExpectError - map3d.assign( x, y, [ 1, 2, 2 ], fcn, {}, {} ); // $ExpectError -} diff --git a/examples/index.js b/examples/index.js deleted file mode 100644 index a35d5e1..0000000 --- a/examples/index.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'; - -var discreteUniform = require( '@stdlib/random-base-discrete-uniform' ).factory; -var filled3dBy = require( '@stdlib/array-base-filled3d-by' ); -var naryFunction = require( '@stdlib/utils-nary-function' ); -var abs = require( '@stdlib/math-base-special-abs' ); -var map3d = require( './../lib' ); - -var shape = [ 3, 3, 3 ]; - -var x = filled3dBy( shape, discreteUniform( -100, 100 ) ); -console.log( x ); - -var y = map3d( x, shape, naryFunction( abs, 1 ) ); -console.log( y ); 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 74c4be1..13202f5 100644 --- a/docs/types/index.d.ts +++ b/index.d.ts @@ -18,7 +18,7 @@ // TypeScript Version: 4.1 -/// +/// import { Array3D } from '@stdlib/types/array'; import { Shape3D } from '@stdlib/types/ndarray'; diff --git a/index.mjs b/index.mjs new file mode 100644 index 0000000..d4b08fe --- /dev/null +++ b/index.mjs @@ -0,0 +1,4 @@ +// Copyright (c) 2026 The Stdlib Authors. License is Apache-2.0: http://www.apache.org/licenses/LICENSE-2.0 +/// +import r from"https://cdn.jsdelivr.net/gh/stdlib-js/utils-define-nonenumerable-read-only-property@v0.2.3-esm/index.mjs";function n(r,n,e,s){var o,t,f,a,i,u,l,p,d,c,h;for(o=n[2],t=n[1],f=n[0],h=[],u=0;u} x - input nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*/\nfunction map3d( x, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\tvar y;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\ty = [];\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = [];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = [];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) );\n\t\t\t}\n\t\t\ty1.push( y0 );\n\t\t}\n\t\ty.push( y1 );\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n* See the License for the specific language governing permissions and\n* limitations under the License.\n*/\n\n'use strict';\n\n// MAIN //\n\n/**\n* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array.\n*\n* ## Notes\n*\n* - The function assumes that the input and output arrays have the same shape.\n*\n* @param {ArrayLikeObject} x - input nested array\n* @param {ArrayLikeObject} y - output nested array\n* @param {NonNegativeIntegerArray} shape - array shape\n* @param {Function} fcn - function to apply\n* @param {*} [thisArg] - function execution context\n* @returns {Array} output array\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\n* // returns true\n*/\nfunction map3d( x, y, shape, fcn, thisArg ) {\n\tvar S0;\n\tvar S1;\n\tvar S2;\n\tvar i0;\n\tvar i1;\n\tvar i2;\n\tvar x0;\n\tvar y0;\n\tvar x1;\n\tvar y1;\n\n\tS0 = shape[ 2 ];\n\tS1 = shape[ 1 ];\n\tS2 = shape[ 0 ];\n\tif ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) {\n\t\treturn y;\n\t}\n\tfor ( i2 = 0; i2 < S2; i2++ ) {\n\t\tx1 = x[ i2 ];\n\t\ty1 = y[ i2 ];\n\t\tfor ( i1 = 0; i1 < S1; i1++ ) {\n\t\t\tx0 = x1[ i1 ];\n\t\t\ty0 = y1[ i1 ];\n\t\t\tfor ( i0 = 0; i0 < S0; i0++ ) {\n\t\t\t\ty0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x );\n\t\t\t}\n\t\t}\n\t}\n\treturn y;\n}\n\n\n// EXPORTS //\n\nexport default map3d;\n","/**\n* @license Apache-2.0\n*\n* Copyright (c) 2023 The Stdlib Authors.\n*\n* Licensed under the Apache License, Version 2.0 (the \"License\");\n* you may not use this file except in compliance with the License.\n* You may obtain a copy of the License at\n*\n* http://www.apache.org/licenses/LICENSE-2.0\n*\n* Unless required by applicable law or agreed to in writing, software\n* distributed under the License is distributed on an \"AS IS\" BASIS,\n* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 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* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array.\n*\n* @module @stdlib/array-base-map3d\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = map3d( x, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* @example\n* import ones3d from '@stdlib/array-base-ones3d';\n* import zeros3d from '@stdlib/array-base-zeros3d';\n* import map3d from '@stdlib/array-base-map3d';\n*\n* function scale( x ) {\n* return x * 10.0;\n* }\n*\n* var shape = [ 1, 2, 2 ];\n*\n* var x = ones3d( shape );\n* var y = zeros3d( shape );\n*\n* var out = map3d.assign( x, y, shape, scale );\n* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ]\n*\n* var bool = ( out === y );\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":["map3d","x","shape","fcn","thisArg","S0","S1","S2","i0","i1","i2","x0","y0","x1","y1","y","push","call","setReadOnly","main","assign"],"mappings":";;wHA4CA,SAASA,EAAOC,EAAGC,EAAOC,EAAKC,GAC9B,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAMJ,IAJAV,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACZa,EAAI,GACEL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAG,EAAKZ,EAAGS,GACRI,EAAK,GACCL,EAAK,EAAGA,EAAKH,EAAIG,IAAO,CAG7B,IAFAE,EAAKE,EAAIJ,GACTG,EAAK,GACCJ,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAGI,KAAMb,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,IAEvDa,EAAGE,KAAMJ,EACT,CACDG,EAAEC,KAAMF,EACR,CACD,OAAOC,CACR,CCpBA,SAASf,EAAOC,EAAGc,EAAGb,EAAOC,EAAKC,GACjC,IAAIC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EACAC,EAKJ,GAHAT,EAAKH,EAAO,GACZI,EAAKJ,EAAO,GACZK,EAAKL,EAAO,GACPG,GAAM,GAAKC,GAAM,GAAKC,GAAM,EAChC,OAAOQ,EAER,IAAML,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAG,EAAKZ,EAAGS,GACRI,EAAKC,EAAGL,GACFD,EAAK,EAAGA,EAAKH,EAAIG,IAGtB,IAFAE,EAAKE,EAAIJ,GACTG,EAAKE,EAAIL,GACHD,EAAK,EAAGA,EAAKH,EAAIG,IACtBI,EAAIJ,GAAOL,EAAIc,KAAMb,EAASO,EAAIH,GAAM,CAAEE,EAAID,EAAID,GAAMP,GAI3D,OAAOc,CACR,CChBAG,EAAAC,EAAA,SAAAC"} \ No newline at end of file diff --git a/lib/assign.js b/lib/assign.js deleted file mode 100644 index 1643f09..0000000 --- a/lib/assign.js +++ /dev/null @@ -1,91 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a three-dimensional nested output array. -* -* ## Notes -* -* - The function assumes that the input and output arrays have the same shape. -* -* @param {ArrayLikeObject} x - input nested array -* @param {ArrayLikeObject} y - output nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // returns true -*/ -function map3d( x, y, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - if ( S0 <= 0 || S1 <= 0 || S2 <= 0 ) { - return y; - } - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = y[ i2 ]; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = y1[ i1 ]; - for ( i0 = 0; i0 < S0; i0++ ) { - y0[ i0 ] = fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ); - } - } - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/lib/index.js b/lib/index.js deleted file mode 100644 index f9c3332..0000000 --- a/lib/index.js +++ /dev/null @@ -1,75 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -* See the License for the specific language governing permissions and -* limitations under the License. -*/ - -'use strict'; - -/** -* Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output array. -* -* @module @stdlib/array-base-map3d -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* var zeros3d = require( '@stdlib/array-base-zeros3d' ); -* var map3d = require( '@stdlib/array-base-map3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = zeros3d( shape ); -* -* var out = map3d.assign( x, y, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -* -* var bool = ( out === y ); -* // 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 2768cd1..0000000 --- a/lib/main.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'; - -// MAIN // - -/** -* Applies a function to elements in a three-dimensional nested input array and assigns results to elements in a new three-dimensional nested output array. -* -* @param {ArrayLikeObject} x - input nested array -* @param {NonNegativeIntegerArray} shape - array shape -* @param {Function} fcn - function to apply -* @param {*} [thisArg] - function execution context -* @returns {Array} output array -* -* @example -* var ones3d = require( '@stdlib/array-base-ones3d' ); -* -* function scale( x ) { -* return x * 10.0; -* } -* -* var shape = [ 1, 2, 2 ]; -* -* var x = ones3d( shape ); -* var y = map3d( x, shape, scale ); -* // returns [ [ [ 10.0, 10.0 ], [ 10.0, 10.0 ] ] ] -*/ -function map3d( x, shape, fcn, thisArg ) { - var S0; - var S1; - var S2; - var i0; - var i1; - var i2; - var x0; - var y0; - var x1; - var y1; - var y; - - S0 = shape[ 2 ]; - S1 = shape[ 1 ]; - S2 = shape[ 0 ]; - y = []; - for ( i2 = 0; i2 < S2; i2++ ) { - x1 = x[ i2 ]; - y1 = []; - for ( i1 = 0; i1 < S1; i1++ ) { - x0 = x1[ i1 ]; - y0 = []; - for ( i0 = 0; i0 < S0; i0++ ) { - y0.push( fcn.call( thisArg, x0[ i0 ], [ i2, i1, i0 ], x ) ); - } - y1.push( y0 ); - } - y.push( y1 ); - } - return y; -} - - -// EXPORTS // - -module.exports = map3d; diff --git a/package.json b/package.json index a6e3644..1cb94b6 100644 --- a/package.json +++ b/package.json @@ -3,31 +3,8 @@ "version": "0.2.3", "description": "Apply a function to elements in a three-dimensional nested input array and assign results to elements in a new three-dimensional nested output 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/types": "^0.5.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.3" - }, - "devDependencies": { - "@stdlib/array-base-filled3d-by": "^0.2.3", - "@stdlib/array-base-zeros3d": "^0.2.3", - "@stdlib/math-base-assert-is-nan": "^0.2.3", - "@stdlib/math-base-special-abs": "^0.2.3", - "@stdlib/math-base-special-floor": "^0.2.4", - "@stdlib/math-base-special-pow": "^0.3.1", - "@stdlib/ndarray-base-numel": "^0.2.3", - "@stdlib/number-float64-base-identity": "^0.1.1", - "@stdlib/random-base-discrete-uniform": "^0.2.2", - "@stdlib/random-base-uniform": "^0.2.3", - "@stdlib/error-tools-fmtprodmsg": "^0.2.3", - "@stdlib/utils-nary-function": "^0.2.4", - "tape": "git+https://github.com/kgryte/tape.git#fix/globby", - "istanbul": "^0.4.1", - "tap-min": "git+https://github.com/Planeshifter/tap-min.git", - "@stdlib/bench-harness": "^0.2.3" - }, - "engines": { - "node": ">=0.10.0", - "npm": ">2.7.0" - }, - "os": [ - "aix", - "darwin", - "freebsd", - "linux", - "macos", - "openbsd", - "sunos", - "win32", - "windows" - ], "keywords": [ "stdlib", "base", diff --git a/stats.html b/stats.html new file mode 100644 index 0000000..0528cec --- /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 903f00b..0000000 --- a/test/test.assign.js +++ /dev/null @@ -1,227 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var zeros3d = require( '@stdlib/array-base-zeros3d' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ).assign; - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - y = zeros3d( shape ); - out = map3d( x, y, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var shape; - var out; - var x; - var y; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = zeros3d( shape ); - - y = zeros3d( shape ); - out = map3d( x, y, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - var y; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - y = zeros3d( shape ); - out = map3d( x, y, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( out, y, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -}); diff --git a/test/test.js b/test/test.js deleted file mode 100644 index c73f2ef..0000000 --- a/test/test.js +++ /dev/null @@ -1,38 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'attached to the main export is an `assign` method', function test( t ) { - t.strictEqual( typeof map3d.assign, 'function', 'method is a function' ); - t.end(); -}); diff --git a/test/test.main.js b/test/test.main.js deleted file mode 100644 index e948179..0000000 --- a/test/test.main.js +++ /dev/null @@ -1,212 +0,0 @@ -/** -* @license Apache-2.0 -* -* Copyright (c) 2023 The Stdlib Authors. -* -* Licensed under the Apache License, Version 2.0 (the "License"); -* you may not use this file except in compliance with the License. -* You may obtain a copy of the License at -* -* http://www.apache.org/licenses/LICENSE-2.0 -* -* Unless required by applicable law or agreed to in writing, software -* distributed under the License is distributed on an "AS IS" BASIS, -* WITHOUT WARRANTIES OR CONDITIONS OF 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 abs = require( '@stdlib/math-base-special-abs' ); -var numel = require( '@stdlib/ndarray-base-numel' ); -var map3d = require( './../lib' ); - - -// TESTS // - -tape( 'main export is a function', function test( t ) { - t.ok( true, __filename ); - t.strictEqual( typeof map3d, 'function', 'main export is a function' ); - t.end(); -}); - -tape( 'the function applies a provided callback to a nested input array and assigns results to a nested output array', function test( t ) { - var expected; - var shape; - var out; - var x; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - out = map3d( x, shape, abs ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a first element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = []; - - out = map3d( x, [ 0, 2, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a second element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [] - ]; - - out = map3d( x, [ 1, 0, 2 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function does not invoke a provided callback if provided a shape having a third element equal to zero', function test( t ) { - var expected; - var out; - var x; - - x = [ - [ - [ -1.0, -2.0 ], - [ -3.0, -4.0 ] - ] - ]; - - expected = [ - [ - [], - [] - ] - ]; - - out = map3d( x, [ 1, 2, 0 ], clbk ); - - t.deepEqual( out, expected, 'returns expected value' ); - t.end(); - - function clbk() { - t.ok( false, 'should not invoke callback' ); - } -}); - -tape( 'the function supports providing a function execution context', function test( t ) { - var expected; - var indices; - var values; - var arrays; - var shape; - var out; - var ctx; - var x; - - values = []; - indices = []; - arrays = []; - - shape = [ 1, 2, 2 ]; - x = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - - ctx = { - 'count': 0 - }; - out = map3d( x, shape, fcn, ctx ); - - expected = [ - [ - [ 1.0, 2.0 ], - [ 3.0, 4.0 ] - ] - ]; - t.deepEqual( out, expected, 'returns expected value' ); - t.strictEqual( ctx.count, numel( shape ), 'returns expected value' ); - - expected = [ - 1.0, - 2.0, - 3.0, - 4.0 - ]; - t.deepEqual( values, expected, 'returns expected value' ); - - expected = [ - [ 0, 0, 0 ], - [ 0, 0, 1 ], - [ 0, 1, 0 ], - [ 0, 1, 1 ] - ]; - t.deepEqual( indices, expected, 'returns expected value' ); - - expected = [ - x, - x, - x, - x - ]; - t.deepEqual( arrays, expected, 'returns expected value' ); - - t.end(); - - function fcn( value, idx, array ) { - values.push( value ); - indices.push( idx ); - arrays.push( array ); - ctx.count += 1; - return value; - } -});