Merge branch 'stdlib-js:develop' into tiny-random

Author: abdelrahman04

.github/workflows/generate_pr_commit_message.yml

@@ -56,9 +56,10 @@ jobs:
         # Pin action to full length commit SHA
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
-          # Ensure we have access to the scripts directory:
+          # Ensure we have access to the scripts directory and .mailmap file for generating the commit message:
           sparse-checkout: |
             .github/workflows/scripts
+            .mailmap
           sparse-checkout-cone-mode: false
 
       # Generate commit message:

.github/workflows/lint_random_files.yml

@@ -230,6 +230,12 @@ jobs:
           \`\`\`
           $(cat lint_editorconfig_errors.txt | strip_ansi)
           \`\`\`
+
+          ### Pull Request Instructions
+
+          -   Please use the following PR title format:
+          "chore: fix EditorConfig lint errors (issue #<ISSUE_NUMBER>)".
+          -   Reference this issue in the "Related Issues" section of the PR body as "resolves #<ISSUE_NUMBER>".
           EOF
 
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \
@@ -370,20 +376,26 @@ jobs:
         run: |
           BODY_FILE="$GITHUB_WORKSPACE/lint_issue_body.md"
           cat << EOF > "$BODY_FILE"
-          ## JavaScript Linting Failures
+            ## JavaScript Linting Failures
 
-          Linting failures were detected in the automated JavaScript lint workflow run.
+            Linting failures were detected in the automated JavaScript lint workflow run.
 
-          ### Workflow Details
+            ### Workflow Details
 
-          - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
-          - Type: JavaScript Linting
-          - Date: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
+            - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+            - Type: JavaScript Linting
+            - Date: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
 
-          ### Error Details
-          \`\`\`
-          $(cat lint_javascript_errors.txt)
-          \`\`\`
+            ### Error Details
+            \`\`\`
+            $(cat lint_javascript_errors.txt)
+            \`\`\`
+
+            ### Pull Request Instructions
+
+            -   Please use the following PR title format:
+            "chore: fix JavaScript lint errors (issue #<ISSUE_NUMBER>)".
+            -   Reference this issue in the "Related Issues" section of the PR body as "resolves #<ISSUE_NUMBER>".
           EOF
 
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \
@@ -524,6 +536,12 @@ jobs:
           \`\`\`
           $(grep -B 1 -A 2 "style:\|warning:\|error:" "lint_c_errors.txt")
           \`\`\`
+
+          ### Pull Request Instructions
+
+          -   Please use the following PR title format:
+          "chore: fix C lint errors (issue #<ISSUE_NUMBER>)".
+          -   Reference this issue in the "Related Issues" section of the PR body as "resolves #<ISSUE_NUMBER>".
           EOF
 
           . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \

.github/workflows/scripts/create_address_commit_comments_issues

@@ -411,6 +411,14 @@ Thank you for your help in reducing the project backlog and in improving the qua
 
 ## Notes
 
+-  When creating your pull request, please use the following format for the PR title:
+
+   \`\`\`
+   chore: address commit comments for commit \`${short_sha}\` (issue #NNNN)
+   \`\`\`
+
+   where \`NNNN\` is the issue number assigned to this issue.
+
 -  For older commits, there is a chance that comments will have been already been addressed due to other refactorings. If you find that to be true, don't worry! Just move on to addressing the next comment, and, when opening your pull request and describing your proposed changes, be sure to link to the comment and mention that it has been addressed. This will help reviewers when reviewing your code!
 
 * * *

lib/node_modules/@stdlib/complex/base/wrap-function/docs/types/index.d.ts

@@ -219,7 +219,7 @@ declare function wrap( fcn: Nullary, nargs: 0, ctor: Constructor ): Nullary;
 *
 * @example
 * var Complex64 = require( '@stdlib/complex/float32/ctor' );
-* var cidentityf = require( '@stdlib/math/base/special/cidentityf' );
+* var cidentityf = require( '@stdlib/complex/float32/base/identity' );
 * var realf = require( '@stdlib/complex/float32/real' );
 * var imagf = require( '@stdlib/complex/float32/imag' );
 *

lib/node_modules/@stdlib/math/base/special/cidentityf/README.md renamed to lib/node_modules/@stdlib/complex/float32/base/identity/README.md

@@ -33,7 +33,7 @@ f(z) = z
 ```
 
 <!-- <div class="equation" align="center" data-raw-text="f(z) = z" data-equation="eq:identity_function">
-    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@79c18caa8e6697ecbe8bcf813a8d54a470168a75/lib/node_modules/@stdlib/math/base/special/cidentityf/docs/img/equation_identity_function.svg" alt="Identity function">
+    <img src="https://cdn.jsdelivr.net/gh/stdlib-js/stdlib@79c18caa8e6697ecbe8bcf813a8d54a470168a75/lib/node_modules/@stdlib/complex/float32/base/identity/docs/img/equation_identity_function.svg" alt="Identity function">
     <br>
 </div> -->
 
@@ -50,7 +50,7 @@ for all `z`.
 ## Usage
 
 ```javascript
-var cidentityf = require( '@stdlib/math/base/special/cidentityf' );
+var cidentityf = require( '@stdlib/complex/float32/base/identity' );
 ```
 
 #### cidentityf( z )
@@ -85,7 +85,7 @@ var im = imag( v );
 ```javascript
 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
 var Complex64 = require( '@stdlib/complex/float32/ctor' );
-var cidentityf = require( '@stdlib/math/base/special/cidentityf' );
+var cidentityf = require( '@stdlib/complex/float32/base/identity' );
 
 var z;
 var i;
@@ -122,17 +122,17 @@ for ( i = 0; i < 100; i++ ) {
 ### Usage
 
 ```c
-#include "stdlib/math/base/special/cidentityf.h"
+#include "stdlib/complex/float32/base/identity.h"
 ```
 
-#### stdlib_base_cidentityf( z )
+#### stdlib_base_complex64_identity( z )
 
 Evaluates the identity function for a single-precision complex floating-point number.
 
 ```c
 #include <complex.h>
 
-float complex y = stdlib_base_cidentityf( 2.0f+2.0f*I );
+float complex y = stdlib_base_complex64_identity( 2.0f+2.0f*I );
 // returns 2.0f+2.0f*I
 ```
 
@@ -141,7 +141,7 @@ The function accepts the following arguments:
 -   **z**: `[in] float complex` input value.
 
 ```c
-float complex stdlib_base_cidentityf( const float complex z );
+float complex stdlib_base_complex64_identity( const float complex z );
 ```
 
 </section>
@@ -163,7 +163,7 @@ float complex stdlib_base_cidentityf( const float complex z );
 ### Examples
 
 ```c
-#include "stdlib/math/base/special/cidentityf.h"
+#include "stdlib/complex/float32/base/identity.h"
 #include <stdio.h>
 #include <complex.h>
 
@@ -175,7 +175,7 @@ int main( void ) {
     int i;
     for ( i = 0; i < 4; i++ ) {
         v = x[ i ];
-        y = stdlib_base_cidentityf( v );
+        y = stdlib_base_complex64_identity( v );
         printf( "f(%f + %f) = %f + %f\n", crealf( v ), cimagf( v ), crealf( y ), cimagf( y ) );
     }
 }

lib/node_modules/@stdlib/math/base/special/cidentityf/benchmark/benchmark.js renamed to lib/node_modules/@stdlib/complex/float32/base/identity/benchmark/benchmark.js

@@ -16,7 +16,7 @@
 * limitations under the License.
 */
 
-#include "stdlib/math/base/special/cidentityf.h"
+#include "stdlib/complex/float32/base/identity.h"
 #include <complex.h>
 #include <stdlib.h>
 #include <stdio.h>
@@ -102,7 +102,7 @@ static double benchmark( void ) {
 	for ( i = 0; i < ITERATIONS; i++ ) {
 		v = ( 1000.0f*rand_float() ) - 500.0f;
 		x = v + v*I;
-		y = stdlib_base_cidentityf( x );
+		y = stdlib_base_complex64_identity( x );
 		if ( crealf( y ) != v ) {
 			printf( "unexpected result\n" );
 			break;