From 9c7ce84719bde0eaea426e2e7e312bf2b8baf00c Mon Sep 17 00:00:00 2001 From: stdlib-bot Date: Sun, 28 Jul 2024 12:40:04 +0000 Subject: [PATCH] Release v0.3.0 --- .gitattributes | 29 ++- .github/workflows/productionize.yml | 23 +- .github/workflows/publish.yml | 11 +- .github/workflows/test.yml | 1 - .github/workflows/test_bundles.yml | 3 - .github/workflows/test_coverage.yml | 1 - .github/workflows/test_install.yml | 1 - .npmrc | 4 +- CHANGELOG.md | 244 +++++++++++++++++- CONTRIBUTORS | 12 +- README.md | 4 +- benchmark/c/native/benchmark.c | 17 +- .../special/fast/alpha_max_plus_beta_min.h | 3 - package.json | 26 +- 14 files changed, 318 insertions(+), 61 deletions(-) diff --git a/.gitattributes b/.gitattributes index 10a16e6..1c88e69 100644 --- a/.gitattributes +++ b/.gitattributes @@ -40,10 +40,27 @@ *.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 +/lib/node_modules/** -linguist-vendored -linguist-generated -# Override what is considered "documentation" by GitHub's linguist: -examples/** linguist-documentation=false +# 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/workflows/productionize.yml b/.github/workflows/productionize.yml index ec90164..f4575e9 100644 --- a/.github/workflows/productionize.yml +++ b/.github/workflows/productionize.yml @@ -94,8 +94,8 @@ jobs: 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' + # Configure Git: + - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" @@ -191,8 +191,8 @@ jobs: # Pin action to full length commit SHA uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - # Configure git: - - name: 'Configure git' + # Configure Git: + - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" @@ -344,7 +344,6 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() @@ -367,8 +366,8 @@ jobs: # Pin action to full length commit SHA uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - # Configure git: - - name: 'Configure git' + # Configure Git: + - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" @@ -518,7 +517,6 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() @@ -541,8 +539,8 @@ jobs: # Pin action to full length commit SHA uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608 # v4.1.0 - # Configure git: - - name: 'Configure git' + # Configure Git: + - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" @@ -698,7 +696,6 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() @@ -738,8 +735,8 @@ jobs: echo "bump=true" >> $GITHUB_OUTPUT fi - # Configure git: - - name: 'Configure git' + # Configure Git: + - name: 'Configure Git' if: steps.check-if-bump.outputs.bump run: | git config --local user.email "noreply@stdlib.io" diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 3eec50e..2888b88 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -72,8 +72,8 @@ jobs: node-version: 20 timeout-minutes: 5 - # Configure git: - - name: 'Configure git' + # Configure Git: + - name: 'Configure Git' run: | git config --local user.email "noreply@stdlib.io" git config --local user.name "stdlib-bot" @@ -94,6 +94,10 @@ jobs: # Replace branch in README.md link definitions for badges with the new version: find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/branch([=:])[^ ]+/branch\1v${NEW_VERSION}/g" + # Rewrite CHANGELOG.md to replace "Unreleased" with the new version: + sed -Ei "s/Unreleased/${NEW_VERSION}/g" CHANGELOG.md + sed -Ei "s/unreleased/v${NEW_VERSION}/g" CHANGELOG.md + # Create a new commit and tag: git add package.json README.md git commit -m "Release v${NEW_VERSION}" @@ -202,7 +206,7 @@ jobs: # Publish package to npm: - name: 'Publish package to npm' # Pin action to full length commit SHA - uses: JS-DevTools/npm-publish@4b07b26a2f6e0a51846e1870223e545bae91c552 # v3.0.1 + uses: JS-DevTools/npm-publish@19c28f1ef146469e409470805ea4279d47c3d35c # v3.1.1 with: token: ${{ secrets.NPM_TOKEN }} access: public @@ -218,7 +222,6 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 11cf5fb..6f032e6 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -95,6 +95,5 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() diff --git a/.github/workflows/test_bundles.yml b/.github/workflows/test_bundles.yml index 6d77abd..5b5879a 100644 --- a/.github/workflows/test_bundles.yml +++ b/.github/workflows/test_bundles.yml @@ -94,7 +94,6 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() @@ -139,7 +138,6 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() @@ -184,6 +182,5 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() diff --git a/.github/workflows/test_coverage.yml b/.github/workflows/test_coverage.yml index f4eda1e..2bcf0cd 100644 --- a/.github/workflows/test_coverage.yml +++ b/.github/workflows/test_coverage.yml @@ -119,7 +119,6 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() diff --git a/.github/workflows/test_install.yml b/.github/workflows/test_install.yml index 8cc1522..3f8ff64 100644 --- a/.github/workflows/test_install.yml +++ b/.github/workflows/test_install.yml @@ -81,6 +81,5 @@ jobs: uses: 8398a7/action-slack@28ba43ae48961b90635b50953d216767a6bea486 # v3.16.2 with: status: ${{ job.status }} - steps: ${{ toJson(steps) }} channel: '#npm-ci' if: failure() diff --git a/.npmrc b/.npmrc index 5af9067..58dbd10 100644 --- a/.npmrc +++ b/.npmrc @@ -27,5 +27,5 @@ shrinkwrap = false # Disable automatically "saving" dependencies on install: save = false -# Generate provenance metadata: -provenance = true +# Do not generate provenance metadata: +provenance = false diff --git a/CHANGELOG.md b/CHANGELOG.md index 6f9ef03..2401d9d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,4 +2,246 @@ > Package changelog. -See [GitHub Releases](https://github.com/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min/releases) for the changelog. \ No newline at end of file +
+ +## 0.3.0 (2024-07-28) + +
+ +### Features + +- [`abf4652`](https://github.com/stdlib-js/stdlib/commit/abf4652e755a88031ee35c182b34d48effe25e43) - add C implementation of `math/base/special/fast/alpha-max-plus-beta-min` [(#1947)](https://github.com/stdlib-js/stdlib/pull/1947) + +
+ + + +
+ +### Closed Issues + +This release closes the following issue: + +[#1938](https://github.com/stdlib-js/stdlib/issues/1938) + +
+ + + +
+ +### Commits + +
+ +- [`272ae7a`](https://github.com/stdlib-js/stdlib/commit/272ae7ac5c576c68cfab1b6e304c86407faa20cd) - **docs:** remove comment _(by Athan Reines)_ +- [`2777e4b`](https://github.com/stdlib-js/stdlib/commit/2777e4be161869d09406e3b17947d24c64b47af2) - **bench:** resolve lint errors in benchmarks _(by Athan Reines)_ +- [`f36cfab`](https://github.com/stdlib-js/stdlib/commit/f36cfab3875404fd9c58b6e2a6fedca5e04cb4d9) - **chore:** update package meta data [(#2014)](https://github.com/stdlib-js/stdlib/pull/2014) _(by stdlib-bot)_ +- [`abf4652`](https://github.com/stdlib-js/stdlib/commit/abf4652e755a88031ee35c182b34d48effe25e43) - **feat:** add C implementation of `math/base/special/fast/alpha-max-plus-beta-min` [(#1947)](https://github.com/stdlib-js/stdlib/pull/1947) _(by Ayaka, Athan Reines)_ +- [`94d7738`](https://github.com/stdlib-js/stdlib/commit/94d7738c835898f9fa6d8904ebd230401aaf8958) - **docs:** remove blank lines [(#1682)](https://github.com/stdlib-js/stdlib/pull/1682) _(by stdlib-bot)_ + +
+ +
+ + + +
+ +### Contributors + +A total of 2 people contributed to this release. Thank you to the following contributors: + +- Athan Reines +- Ayaka + +
+ + + +
+ + + +
+ +## 0.2.1 (2024-02-23) + +No changes reported for this release. + +
+ + + +
+ +## 0.2.0 (2024-02-14) + +
+ +### Commits + +
+ +- [`57d81e4`](https://github.com/stdlib-js/stdlib/commit/57d81e4c196065f6680f08f22aeccfdc6e590b8f) - **docs:** update related packages sections [(#1151)](https://github.com/stdlib-js/stdlib/pull/1151) _(by stdlib-bot)_ +- [`453dd85`](https://github.com/stdlib-js/stdlib/commit/453dd85b5dd186d2b4d458256fe84906e1503fe2) - **build:** remove tslint directives _(by Philipp Burckhardt)_ + +
+ +
+ + + +
+ +### Contributors + +A total of 1 person contributed to this release. Thank you to this contributor: + +- Philipp Burckhardt + +
+ + + +
+ + + +
+ +## 0.1.1 (2023-10-09) + +No changes reported for this release. + +
+ + + +
+ +## 0.1.0 (2023-09-23) + +
+ +### Features + +- [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9) - update minimum TypeScript version + +
+ + + +
+ +### BREAKING CHANGES + +- [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9): update minimum TypeScript version +- [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9): update minimum TypeScript version to 4.1 + + - To migrate, users should upgrade their TypeScript version to at least version 4.1. + +
+ + + +
+ +### Commits + +
+ +- [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9) - **feat:** update minimum TypeScript version _(by Philipp Burckhardt)_ + +
+ +
+ + + +
+ +### Contributors + +A total of 1 person contributed to this release. Thank you to this contributor: + +- Philipp Burckhardt + +
+ + + +
+ + + +
+ +## 0.0.7 (2022-02-16) + +No changes reported for this release. + +
+ + + +
+ +## 0.0.6 (2021-08-22) + +No changes reported for this release. + +
+ + + +
+ +## 0.0.5 (2021-07-07) + +No changes reported for this release. + +
+ + + +
+ +## 0.0.4 (2021-06-27) + +No changes reported for this release. + +
+ + + +
+ +## 0.0.3 (2021-06-16) + +No changes reported for this release. + +
+ + + +
+ +## 0.0.2 (2021-06-15) + +No changes reported for this release. + +
+ + + +
+ +## 0.0.1 (2021-06-14) + +No changes reported for this release. + +
+ + + diff --git a/CONTRIBUTORS b/CONTRIBUTORS index 4500383..26a1c46 100644 --- a/CONTRIBUTORS +++ b/CONTRIBUTORS @@ -5,6 +5,7 @@ Adarsh Palaskar Aditya Sapra AgPriyanshu18 <113460573+AgPriyanshu18@users.noreply.github.com> +Aleksandr <112382387+alextes90@users.noreply.github.com> Ali Salesi Aman Bhansali Amit Jimiwal @@ -18,6 +19,7 @@ Chinmay Joshi <86140365+JawHawk@users.noreply.github.com> Christopher Dambamuromo Dan Rose Daniel Killenberger +Daniel Yu <40680511+Daniel777y@users.noreply.github.com> Dominik Moritz Dorrin Sotoudeh EuniceSim142 <77243938+EuniceSim142@users.noreply.github.com> @@ -25,6 +27,7 @@ Frank Kovacs Golden Kumar <103646877+AuenKr@users.noreply.github.com> Gunj Joshi Harshita Kalani +Hridyanshu <124202756+HRIDYANSHU054@users.noreply.github.com> Jaimin Godhani <112328542+Jai0401@users.noreply.github.com> James Gelok Jaysukh Makvana @@ -48,6 +51,7 @@ Muhammad Haris Naresh Jagadeesan NightKnight Nithin Katta <88046362+nithinkatta@users.noreply.github.com> +Nourhan Hasan <109472010+TheNourhan@users.noreply.github.com> Ognjen Jevremović Oneday12323 <107678750+Oneday12323@users.noreply.github.com> Philipp Burckhardt @@ -60,6 +64,7 @@ Pushpendra Chandravanshi Raunak Kumar Gupta Rejoan Sardar <119718513+Rejoan-Sardar@users.noreply.github.com> Ricky Reusser +Ridam Garg <67867319+RidamGarg@users.noreply.github.com> Robert Gislason Roman Stetsyk <25715951+romanstetsyk@users.noreply.github.com> Rutam <138517416+performant23@users.noreply.github.com> @@ -69,8 +74,11 @@ Seyyed Parsa Neshaei Shashank Shekhar Singh Shivam <11shivam00@gmail.com> Shraddheya Shendre +Shubh Mehta <93862397+Shubh942@users.noreply.github.com> Shubham Mishra -Snehil Shah <130062020+Snehil-Shah@users.noreply.github.com> +Sivam Das <100067002+Sivam2313@users.noreply.github.com> +Snehil Shah +Soumajit Chatterjee <121816890+soumajit23@users.noreply.github.com> Spandan Barve Stephannie Jiménez Gacha Suraj kumar <125961509+kumarsuraj212003@users.noreply.github.com> @@ -79,8 +87,10 @@ Tudor Pagu <104032457+tudor-pagu@users.noreply.github.com> Utkarsh Utkarsh Raj Varad Gupta +Xiaochuan Ye Yernar Yergaziyev naveen nishant-s7 <97207366+nishant-s7@users.noreply.github.com> orimiles5 <97595296+orimiles5@users.noreply.github.com> +rainn <88160429+AmCodesLame@users.noreply.github.com> rei2hu diff --git a/README.md b/README.md index 4c76b1b..1707557 100644 --- a/README.md +++ b/README.md @@ -308,8 +308,8 @@ Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors]. [npm-image]: http://img.shields.io/npm/v/@stdlib/math-base-special-fast-alpha-max-plus-beta-min.svg [npm-url]: https://npmjs.org/package/@stdlib/math-base-special-fast-alpha-max-plus-beta-min -[test-image]: https://github.com/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min/actions/workflows/test.yml/badge.svg?branch=main -[test-url]: https://github.com/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min/actions/workflows/test.yml?query=branch:main +[test-image]: https://github.com/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min/actions/workflows/test.yml/badge.svg?branch=v0.3.0 +[test-url]: https://github.com/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min/actions/workflows/test.yml?query=branch:v0.3.0 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min/main.svg [coverage-url]: https://codecov.io/github/stdlib-js/math-base-special-fast-alpha-max-plus-beta-min?branch=main diff --git a/benchmark/c/native/benchmark.c b/benchmark/c/native/benchmark.c index 9726080..f725395 100644 --- a/benchmark/c/native/benchmark.c +++ b/benchmark/c/native/benchmark.c @@ -16,9 +16,6 @@ * limitations under the License. */ -/** -* Benchmark `alpha-max-plus-beta-min`. -*/ #include "stdlib/math/base/special/fast/alpha_max_plus_beta_min.h" #include #include @@ -33,7 +30,7 @@ /** * Prints the TAP version. */ -void print_version() { +static void print_version( void ) { printf( "TAP version 13\n" ); } @@ -43,7 +40,7 @@ void print_version() { * @param total total number of tests * @param passing total number of passing tests */ -void print_summary( int total, int passing ) { +static void print_summary( int total, int passing ) { printf( "#\n" ); printf( "1..%d\n", total ); // TAP plan printf( "# total %d\n", total ); @@ -57,7 +54,7 @@ void print_summary( int total, int passing ) { * * @param elapsed elapsed time in seconds */ -void print_results( double elapsed ) { +static void print_results( double elapsed ) { double rate = (double)ITERATIONS / elapsed; printf( " ---\n" ); printf( " iterations: %d\n", ITERATIONS ); @@ -71,18 +68,18 @@ void print_results( double elapsed ) { * * @return clock time */ -double tic() { +static double tic( void ) { struct timeval now; gettimeofday( &now, NULL ); return (double)now.tv_sec + (double)now.tv_usec/1.0e6; } /** -* Generates a random number on the interval [0,1]. +* Generates a random number on the interval [0,1). * * @return random number */ -double rand_double() { +static double rand_double( void ) { int r = rand(); return (double)r / ( (double)RAND_MAX + 1.0 ); } @@ -92,7 +89,7 @@ double rand_double() { * * @return elapsed time in seconds */ -double benchmark() { +static double benchmark( void ) { double elapsed; double x; double y; diff --git a/include/stdlib/math/base/special/fast/alpha_max_plus_beta_min.h b/include/stdlib/math/base/special/fast/alpha_max_plus_beta_min.h index 169f849..0935577 100644 --- a/include/stdlib/math/base/special/fast/alpha_max_plus_beta_min.h +++ b/include/stdlib/math/base/special/fast/alpha_max_plus_beta_min.h @@ -16,9 +16,6 @@ * limitations under the License. */ -/** -* Header file containing function declarations. -*/ #ifndef STDLIB_MATH_BASE_SPECIAL_FAST_ALPHA_MAX_PLUS_BETA_MIN_H #define STDLIB_MATH_BASE_SPECIAL_FAST_ALPHA_MAX_PLUS_BETA_MIN_H diff --git a/package.json b/package.json index 9ae2267..902e92c 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@stdlib/math-base-special-fast-alpha-max-plus-beta-min", - "version": "0.2.1", + "version": "0.3.0", "description": "Compute the hypotenuse using the alpha max plus beta min algorithm.", "license": "Apache-2.0", "author": { @@ -40,25 +40,25 @@ "url": "https://github.com/stdlib-js/stdlib/issues" }, "dependencies": { - "@stdlib/math-base-napi-binary": "^0.2.1", - "@stdlib/math-base-special-fast-abs": "^0.2.1", - "@stdlib/math-base-special-labs": "^0.2.1", - "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.1", - "@stdlib/utils-library-manifest": "^0.2.1" + "@stdlib/math-base-napi-binary": "^0.3.0", + "@stdlib/math-base-special-fast-abs": "^0.3.0", + "@stdlib/math-base-special-labs": "^0.2.2", + "@stdlib/utils-define-nonenumerable-read-only-property": "^0.2.2", + "@stdlib/utils-library-manifest": "^0.2.2" }, "devDependencies": { - "@stdlib/math-base-assert-is-nan": "^0.2.1", - "@stdlib/math-base-special-abs": "^0.2.1", - "@stdlib/math-base-special-ceil": "^0.2.1", - "@stdlib/math-base-special-hypot": "^0.2.1", - "@stdlib/math-base-special-round": "^0.2.1", + "@stdlib/math-base-assert-is-nan": "^0.2.2", + "@stdlib/math-base-special-abs": "^0.2.2", + "@stdlib/math-base-special-ceil": "^0.2.2", + "@stdlib/math-base-special-hypot": "^0.2.2", + "@stdlib/math-base-special-round": "^0.3.0", "@stdlib/math-base-special-roundn": "^0.2.1", "@stdlib/random-base-randu": "^0.2.1", - "@stdlib/utils-try-require": "^0.2.1", + "@stdlib/utils-try-require": "^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.1" + "@stdlib/bench-harness": "^0.2.2" }, "engines": { "node": ">=0.10.0",