Merge branch 'develop' into markdown-related-packages

Signed-off-by: Athan <[email protected]>

Author: kgryte

.github/workflows/lint_random_files.yml

@@ -197,9 +197,42 @@ jobs:
 
       # Lint files against EditorConfig:
       - name: 'Lint against EditorConfig'
+        id: lint-editorconfig
         run: |
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' ' ')
-          make lint-editorconfig-files FILES="${files}"
+          make lint-editorconfig-files FILES="${files}" 2>&1 | tee lint_editorconfig_errors.txt
+
+      # Create sub-issue for EditorConfig lint failures:
+      - name: 'Create sub-issue for EditorConfig lint failures'
+        if: failure() && contains(steps.lint-editorconfig.outcome, 'failure')
+        env:
+          GITHUB_TOKEN: ${{ secrets.STDLIB_BOT_PAT_REPO_WRITE }}
+        run: |
+          BODY_FILE="$GITHUB_WORKSPACE/lint_issue_body.md"
+          cat << EOF > "$BODY_FILE"
+          ## EditorConfig Linting Failures
+
+          Linting failures were detected in the automated EditorConfig lint workflow run.
+
+          ### Workflow Details
+
+          - Run: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}
+          - Type: EditorConfig Linting
+          - Date: $(date -u +"%Y-%m-%d %H:%M:%S UTC")
+
+          ### Error Details
+
+          \`\`\`
+          $(cat lint_editorconfig_errors.txt)
+          \`\`\`
+          EOF
+
+          . "$GITHUB_WORKSPACE/.github/workflows/scripts/create_sub_issue" \
+            'Fix EditorConfig lint errors' \
+            "$BODY_FILE" \
+            "5156"
+
+          rm "$BODY_FILE"
 
       # Lint Markdown files:
       - name: 'Lint Markdown files'
@@ -383,28 +416,31 @@ jobs:
           echo "" > "$out_benchmarks"
           echo "" > "$combined"
 
+          # Initialize an error flag:
+          error=0
+
           # Lint C source files:
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep -E '\.c$' | grep -v -e '/examples' -e '/test' -e '/benchmark' | tr '\n' ' ')
           if [[ -n "${files}" ]]; then
-            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_source}"
+            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_source}" || error=1
           fi
 
           # Lint C example files...
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '/examples/.*\.c$' | tr '\n' ' ')
           if [[ -n "${files}" ]]; then
-            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_examples}" CPPCHECK_SUPPRESSIONS_LIST="${cppcheck_examples_suppressions_list}"
+            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_examples}" CPPCHECK_SUPPRESSIONS_LIST="${cppcheck_examples_suppressions_list}" || error=1
           fi
 
           # Lint C test fixtures files...
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '/test/fixtures/.*\.c$' | tr '\n' ' ')
           if [[ -n "${files}" ]]; then
-            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_tests}" CPPCHECK_SUPPRESSIONS_LIST="${cppcheck_tests_fixtures_suppressions_list}"
+            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_tests}" CPPCHECK_SUPPRESSIONS_LIST="${cppcheck_tests_fixtures_suppressions_list}" || error=1
           fi
 
           # Lint C benchmark files...
           files=$(echo "${{ steps.random-files.outputs.files }}" | tr ',' '\n' | grep '/benchmark/.*\.c$' | tr '\n' ' ')
           if [[ -n "${files}" ]]; then
-            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_benchmarks}" CPPCHECK_SUPPRESSIONS_LIST="${cppcheck_benchmarks_suppressions_list}"
+            make lint-c-files FILES="${files}" CPPCHECK_FLAGS="--output-file=${out_benchmarks}" CPPCHECK_SUPPRESSIONS_LIST="${cppcheck_benchmarks_suppressions_list}" || error=1
           fi
 
           # Combine all outputs into one file:
@@ -413,6 +449,11 @@ jobs:
           # Print the combined errors to the log:
           cat "$combined"
 
+          # If any linting command failed, exit with error:
+          if [[ $error -ne 0 ]]; then
+            exit 1
+          fi
+
       # Create sub-issue for C linting failures:
       - name: 'Create sub-issue for C lint failures'
         if: ( github.event.inputs.c != 'false' ) && failure() && contains(steps.*.outcome, 'failure') && contains(steps.lint-c.outcome, 'failure')

lib/node_modules/@stdlib/blas/ext/base/README.md

@@ -114,8 +114,8 @@ var ns = extblas;
 -   <span class="signature">[`gsort2ins( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two strided arrays based on the sort order of the first array using insertion sort.</span>
 -   <span class="signature">[`gsort2sh( N, order, x, strideX, y, strideY )`][@stdlib/blas/ext/base/gsort2sh]</span><span class="delimiter">: </span><span class="description">simultaneously sort two strided arrays based on the sort order of the first array using Shellsort.</span>
 -   <span class="signature">[`gsorthp( N, order, x, strideX )`][@stdlib/blas/ext/base/gsorthp]</span><span class="delimiter">: </span><span class="description">sort a strided array using heapsort.</span>
--   <span class="signature">[`gsortins( N, order, x, stride )`][@stdlib/blas/ext/base/gsortins]</span><span class="delimiter">: </span><span class="description">sort a strided array using insertion sort.</span>
--   <span class="signature">[`gsortsh( N, order, x, stride )`][@stdlib/blas/ext/base/gsortsh]</span><span class="delimiter">: </span><span class="description">sort a strided array using Shellsort.</span>
+-   <span class="signature">[`gsortins( N, order, x, strideX )`][@stdlib/blas/ext/base/gsortins]</span><span class="delimiter">: </span><span class="description">sort a strided array using insertion sort.</span>
+-   <span class="signature">[`gsortsh( N, order, x, strideX )`][@stdlib/blas/ext/base/gsortsh]</span><span class="delimiter">: </span><span class="description">sort a strided array using Shellsort.</span>
 -   <span class="signature">[`gsum( N, x, strideX )`][@stdlib/blas/ext/base/gsum]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements.</span>
 -   <span class="signature">[`gsumkbn( N, x, strideX )`][@stdlib/blas/ext/base/gsumkbn]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using an improved Kahan–Babuška algorithm.</span>
 -   <span class="signature">[`gsumkbn2( N, x, strideX )`][@stdlib/blas/ext/base/gsumkbn2]</span><span class="delimiter">: </span><span class="description">calculate the sum of strided array elements using a second-order iterative Kahan–Babuška algorithm.</span>

lib/node_modules/@stdlib/blas/ext/base/cfill/README.md

@@ -259,11 +259,11 @@ console.log( x.get( 0 ).toString() );
 
 <!-- /.examples -->
 
-<!-- C interface documentation >
+<!-- C interface documentation. -->
 
 * * *
 
-<section class="C">
+<section class="c">
 
 ## C APIs
 

lib/node_modules/@stdlib/blas/ext/base/docs/types/index.d.ts

@@ -2102,7 +2102,7 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param order - sort order
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns `x`
 	*
 	* @example
@@ -2125,7 +2125,7 @@ interface Namespace {
 	* @param N - number of indexed elements
 	* @param order - sort order
 	* @param x - input array
-	* @param stride - stride length
+	* @param strideX - stride length
 	* @returns `x`
 	*
 	* @example

lib/node_modules/@stdlib/blas/ext/base/dsortins/README.md

@@ -148,12 +148,133 @@ console.log( x );
 
 <!-- /.examples -->
 
+<!-- C interface documentation. -->
+
+* * *
+
+<section class="c">
+
+## C APIs
+
+<!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. -->
+
+<section class="intro">
+
+</section>
+
+<!-- /.intro -->
+
+<!-- C usage documentation. -->
+
+<section class="usage">
+
+### Usage
+
+```c
+#include "stdlib/blas/ext/base/dsortins.h"
+```
+
+#### stdlib_strided_dsortins( N, order, \*X, strideX )
+
+Sorts a double-precision floating-point strided array using insertion sort.
+
+```c
+double x[] = { 1.0, -2.0, 3.0, -4.0 };
+
+stdlib_strided_dsortins( 2, -1.0, x, 1 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **order**: `[in] double` sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
+-   **X**: `[inout] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+
+```c
+stdlib_strided_dsortins( const CBLAS_INT N, const double order, double *X, const CBLAS_INT strideX );
+```
+
+<!--lint disable maximum-heading-length-->
+
+#### stdlib_strided_dsortins_ndarray( N, order, \*X, strideX, offsetX )
+
+<!--lint enable maximum-heading-length-->
+
+Sorts a double-precision floating-point strided array using insertion sort and alternative indexing semantics.
+
+```c
+double x[] = { 1.0, -2.0, 3.0, -4.0 };
+
+stdlib_strided_dsortins_ndarray( 4, 1.0, x, 1, 0 );
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **order**: `[in] double` sort order. If `order < 0.0`, the input strided array is sorted in **decreasing** order. If `order > 0.0`, the input strided array is sorted in **increasing** order. If `order == 0.0`, the input strided array is left unchanged.
+-   **X**: `[inout] double*` input array.
+-   **strideX**: `[in] CBLAS_INT` stride length for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+
+```c
+stdlib_strided_dsortins_ndarray( const CBLAS_INT N, const double order, double *X, const CBLAS_INT strideX, const CBLAS_INT offsetX );
+```
+
+</section>
+
+<!-- /.usage -->
+
+<!-- C API usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="notes">
+
+</section>
+
+<!-- /.notes -->
+
+<!-- C API usage examples. -->
+
+<section class="examples">
+
+### Examples
+
+```c
+#include "stdlib/blas/ext/base/dsortins.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create a strided array:
+    double x[] = { 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 };
+
+    // Specify the number of elements:
+    int N = 8;
+
+    // Specify a stride:
+    int strideX = 1;
+
+    // Sort the array:
+    stdlib_strided_dsortins( N, 1.0, x, strideX );
+
+    // Print the result:
+    for ( int i = 0; i < 8; i++ ) {
+        printf( "x[ %i ] = %lf\n", i, x[ i ] );
+    }
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">
 
-* * *
-
 ## See Also
 
 -   <span class="package-name">[`@stdlib/blas/ext/base/dsort2ins`][@stdlib/blas/ext/base/dsort2ins]</span><span class="delimiter">: </span><span class="description">simultaneously sort two double-precision floating-point strided arrays based on the sort order of the first array using insertion sort.</span>

lib/node_modules/@stdlib/blas/ext/base/zfill/README.md

@@ -259,11 +259,11 @@ console.log( x.get( 0 ).toString() );
 
 <!-- /.examples -->
 
-<!-- C interface documentation >
+<!-- C interface documentation. -->
 
 * * *
 
-<section class="C">
+<section class="c">
 
 ## C APIs