Auto-generated commit

stdlib-js · Jul 16, 2024 · eeacadb · eeacadb
1 parent 3f16cf1
commit eeacadb
Show file tree

Hide file tree

Showing 31 changed files with 202 additions and 64 deletions.
diff --git 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
@@ -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()
 
@@ -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()
 
@@ -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()
 

diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml
@@ -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}"
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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/CHANGELOG.md b/CHANGELOG.md
@@ -2,4 +2,124 @@
 
 > Package changelog.
 
-See [GitHub Releases](https://github.com/stdlib-js/math-base-special-cpolar/releases) for the changelog.
+<section class="release" id="unreleased">
+
+## Unreleased (2024-07-16)
+
+<section class="bug-fixes">
+
+### Bug Fixes
+
+-   [`cf3f92e`](https://github.com/stdlib-js/stdlib/commit/cf3f92eddd20ec1a4106c8a34f7d7705a9a99dbc) - update include paths
+
+</section>
+
+<!-- /.bug-fixes -->
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`8908bda`](https://github.com/stdlib-js/stdlib/commit/8908bda11588f80edf375466ae9e84a3d70cf7d3) - **refactor:** update paths _(by Athan Reines)_
+-   [`d04dcbd`](https://github.com/stdlib-js/stdlib/commit/d04dcbd6dc3b0bf4a89bd3947d317fa5ff15bb38) - **docs:** remove private annotations in C comments _(by Philipp Burckhardt)_
+-   [`038b199`](https://github.com/stdlib-js/stdlib/commit/038b199c32842c02cf678e3ae8305a17aacda05e) - **docs:** update paths _(by Athan Reines)_
+-   [`cf3f92e`](https://github.com/stdlib-js/stdlib/commit/cf3f92eddd20ec1a4106c8a34f7d7705a9a99dbc) - **fix:** update include paths _(by Athan Reines)_
+-   [`75d4f83`](https://github.com/stdlib-js/stdlib/commit/75d4f83cb85610d23a04dc21a03f8075f6d3665f) - **refactor:** update require and include paths _(by Athan Reines)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 2 people contributed to this release. Thank you to the following contributors:
+
+-   Athan Reines
+-   Philipp Burckhardt
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
+<section class="release" id="v0.2.1">
+
+## 0.2.1 (2024-02-24)
+
+<section class="features">
+
+### Features
+
+-   [`36d8cb7`](https://github.com/stdlib-js/stdlib/commit/36d8cb755436aafd5b7bb085212de5e629b47457) - remove support for out argument and add C implementation [(#1067)](https://github.com/stdlib-js/stdlib/pull/1067)
+-   [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9) - update minimum TypeScript version
+-   [`291afa4`](https://github.com/stdlib-js/stdlib/commit/291afa4b085af5e4eb47d9f1290d227542e391fa) - add C implementation to `math/base/special/cphase` [(#1004)](https://github.com/stdlib-js/stdlib/pull/1004)
+
+</section>
+
+<!-- /.features -->
+
+<section class="breaking-changes">
+
+### BREAKING CHANGES
+
+-   [`36d8cb7`](https://github.com/stdlib-js/stdlib/commit/36d8cb755436aafd5b7bb085212de5e629b47457): remove support for out argument and add C implementation
+-   [`36d8cb7`](https://github.com/stdlib-js/stdlib/commit/36d8cb755436aafd5b7bb085212de5e629b47457): remove support for out argument 
+
+    -   In order to migrate, users should provide a complex number object as an input argument and handle a complex number object as a return value.
+
+-   [`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.
+
+</section>
+
+<!-- /.breaking-changes -->
+
+<section class="commits">
+
+### Commits
+
+<details>
+
+-   [`dea49e0`](https://github.com/stdlib-js/stdlib/commit/dea49e03ab5571233e3da26835a6a6d3256d5737) - **docs:** use single quotes in require calls instead of backticks _(by Philipp Burckhardt)_
+-   [`215dfe6`](https://github.com/stdlib-js/stdlib/commit/215dfe690670731f044d09c92832081bc99372cc) - **docs:** update links _(by Athan Reines)_
+-   [`453dd85`](https://github.com/stdlib-js/stdlib/commit/453dd85b5dd186d2b4d458256fe84906e1503fe2) - **build:** remove tslint directives _(by Philipp Burckhardt)_
+-   [`c244466`](https://github.com/stdlib-js/stdlib/commit/c2444664e2c668563b5842d066a74148b1d2ff76) - **chore:** update package meta data [(#1093)](https://github.com/stdlib-js/stdlib/pull/1093) _(by stdlib-bot, Athan Reines)_
+-   [`36d8cb7`](https://github.com/stdlib-js/stdlib/commit/36d8cb755436aafd5b7bb085212de5e629b47457) - **feat:** remove support for out argument and add C implementation [(#1067)](https://github.com/stdlib-js/stdlib/pull/1067) _(by Stephannie Jiménez Gacha, Athan Reines)_
+-   [`58832ee`](https://github.com/stdlib-js/stdlib/commit/58832eef6d93e6519622148242600eae93dca4d9) - **feat:** update minimum TypeScript version _(by Philipp Burckhardt)_
+-   [`291afa4`](https://github.com/stdlib-js/stdlib/commit/291afa4b085af5e4eb47d9f1290d227542e391fa) - **feat:** add C implementation to `math/base/special/cphase` [(#1004)](https://github.com/stdlib-js/stdlib/pull/1004) _(by Stephannie Jiménez Gacha, Athan Reines)_
+
+</details>
+
+</section>
+
+<!-- /.commits -->
+
+<section class="contributors">
+
+### Contributors
+
+A total of 3 people contributed to this release. Thank you to the following contributors:
+
+-   Athan Reines
+-   Philipp Burckhardt
+-   Stephannie Jiménez Gacha
+
+</section>
+
+<!-- /.contributors -->
+
+</section>
+
+<!-- /.release -->
+
diff --git a/CONTRIBUTORS b/CONTRIBUTORS
@@ -5,6 +5,7 @@
 Adarsh Palaskar <[email protected]>
 Aditya Sapra <[email protected]>
 AgPriyanshu18 <[email protected]>
+Aleksandr <[email protected]>
 Ali Salesi <[email protected]>
 Aman Bhansali <[email protected]>
 Amit Jimiwal <[email protected]>
@@ -18,13 +19,15 @@ Chinmay Joshi <[email protected]>
 Christopher Dambamuromo <[email protected]>
 Dan Rose <[email protected]>
 Daniel Killenberger <[email protected]>
+Daniel Yu <[email protected]>
 Dominik Moritz <[email protected]>
 Dorrin Sotoudeh <[email protected]>
 EuniceSim142 <[email protected]>
 Frank Kovacs <[email protected]>
 Golden Kumar <[email protected]>
 Gunj Joshi <[email protected]>
 Harshita Kalani <[email protected]>
+Hridyanshu <[email protected]>
 Jaimin Godhani <[email protected]>
 James Gelok <[email protected]>
 Jaysukh Makvana <[email protected]>
@@ -60,6 +63,7 @@ Pushpendra Chandravanshi <[email protected]>
 Raunak Kumar Gupta <[email protected]>
 Rejoan Sardar <[email protected]>
 Ricky Reusser <[email protected]>
+Ridam Garg <[email protected]>
 Robert Gislason <[email protected]>
 Roman Stetsyk <[email protected]>
 Rutam <[email protected]>
@@ -69,8 +73,11 @@ Seyyed Parsa Neshaei <[email protected]>
 Shashank Shekhar Singh <[email protected]>
 Shivam <[email protected]>
 Shraddheya Shendre <[email protected]>
+Shubh Mehta <[email protected]>
 Shubham Mishra <[email protected]>
-Snehil Shah <[email protected]>
+Sivam Das <[email protected]>
+Snehil Shah <[email protected]>
+Soumajit Chatterjee <[email protected]>
 Spandan Barve <[email protected]>
 Stephannie Jiménez Gacha <[email protected]>
 Suraj kumar <[email protected]>
@@ -79,8 +86,10 @@ Tudor Pagu <[email protected]>
 Utkarsh <http://[email protected]>
 Utkarsh Raj <[email protected]>
 Varad Gupta <[email protected]>
+Xiaochuan Ye <[email protected]>
 Yernar Yergaziyev <[email protected]>
 naveen <[email protected]>
 nishant-s7 <[email protected]>
 orimiles5 <[email protected]>
+rainn <[email protected]>
 rei2hu <[email protected]>
diff --git a/README.md b/README.md
@@ -74,7 +74,7 @@ var cpolar = require( '@stdlib/math-base-special-cpolar' );
 Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number.
 
 ```javascript
-var Complex128 = require( '@stdlib/complex-float64' );
+var Complex128 = require( '@stdlib/complex-float64-ctor' );
 
 var o = cpolar( new Complex128( 5.0, 3.0 ) );
 // returns [ ~5.83, ~0.5404 ]
@@ -85,7 +85,7 @@ var o = cpolar( new Complex128( 5.0, 3.0 ) );
 Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number and assigns results to a provided output array.
 
 ```javascript
-var Complex128 = require( '@stdlib/complex-float64' );
+var Complex128 = require( '@stdlib/complex-float64-ctor' );
 var Float64Array = require( '@stdlib/array-float64' );
 
 var out = new Float64Array( 2 );
@@ -108,7 +108,7 @@ var bool = ( v === out );
 <!-- eslint no-undef: "error" -->
 
 ```javascript
-var Complex128 = require( '@stdlib/complex-float64' );
+var Complex128 = require( '@stdlib/complex-float64-ctor' );
 var randu = require( '@stdlib/random-base-randu' );
 var round = require( '@stdlib/math-base-special-round' );
 var real = require( '@stdlib/complex-real' );
@@ -166,7 +166,7 @@ for ( i = 0; i < 100; i++ ) {
 Computes the [absolute value][@stdlib/math/base/special/cabs] and [phase][@stdlib/math/base/special/cphase] of a double-precision complex floating-point number.
 
 ```c
-#include "stdlib/complex/float64.h"
+#include "stdlib/complex/float64/ctor.h"
 #include "stdlib/complex/real.h"
 #include "stdlib/complex/imag.h"
 
@@ -206,8 +206,8 @@ double stdlib_base_cpolar( const stdlib_complex128_t z, double *cabs, double *cp
 
 ```c
 #include "stdlib/math/base/special/cpolar.h"
-#include "stdlib/complex/float64.h"
-#include "stdlib/complex/reim.h"
+#include "stdlib/complex/float64/ctor.h"
+#include "stdlib/complex/float64/reim.h"
 #include <stdio.h>
 
 int main( void ) {
@@ -223,9 +223,9 @@ int main( void ) {
     double re;
     double im;
     int i;
-    for ( i = 0; i < 12; i++ ) {
+    for ( i = 0; i < 4; i++ ) {
         stdlib_base_cpolar( x[i], &cabs, &cphase );
-        stdlib_reim( x[i], &re, &im );
+        stdlib_complex128_reim( x[i], &re, &im );
         printf( "cpolar(%lf + %lfi) => cabs: %lf, cphase: %lf\n", re, im, cabs, cphase );
     }
 }

diff --git a/benchmark/benchmark.js b/benchmark/benchmark.js
@@ -23,7 +23,7 @@
 var bench = require( '@stdlib/bench-harness' );
 var uniform = require( '@stdlib/random-base-uniform' );
 var isArray = require( '@stdlib/assert-is-array' );
-var Complex128 = require( '@stdlib/complex-float64' );
+var Complex128 = require( '@stdlib/complex-float64-ctor' );
 var pkg = require( './../package.json' ).name;
 var cpolar = require( './../lib' );
 

diff --git a/benchmark/benchmark.native.js b/benchmark/benchmark.native.js
@@ -24,7 +24,7 @@ var resolve = require( 'path' ).resolve;
 var bench = require( '@stdlib/bench-harness' );
 var uniform = require( '@stdlib/random-base-uniform' );
 var isArray = require( '@stdlib/assert-is-array' );
-var Complex128 = require( '@stdlib/complex-float64' );
+var Complex128 = require( '@stdlib/complex-float64-ctor' );
 var tryRequire = require( '@stdlib/utils-try-require' );
 var pkg = require( './../package.json' ).name;
 

diff --git a/benchmark/c/native/benchmark.c b/benchmark/c/native/benchmark.c
@@ -20,8 +20,8 @@
 * Benchmark `cpolar`.
 */
 #include "stdlib/math/base/special/cpolar.h"
-#include "stdlib/complex/float64.h"
-#include "stdlib/complex/reim.h"
+#include "stdlib/complex/float64/ctor.h"
+#include "stdlib/complex/float64/reim.h"
 #include <stdlib.h>
 #include <stdio.h>
 #include <math.h>