chore: clean-up and support negative strides

---
type: pre_commit_static_analysis_report
description: Results of running static analysis checks when committing changes.
report:
  - task: lint_filenames
    status: passed
  - task: lint_editorconfig
    status: passed
  - task: lint_markdown
    status: passed
  - task: lint_package_json
    status: passed
  - task: lint_repl_help
    status: passed
  - task: lint_javascript_src
    status: passed
  - task: lint_javascript_cli
    status: na
  - task: lint_javascript_examples
    status: passed
  - task: lint_javascript_tests
    status: passed
  - task: lint_javascript_benchmarks
    status: na
  - task: lint_python
    status: na
  - task: lint_r
    status: na
  - task: lint_c_src
    status: na
  - task: lint_c_examples
    status: na
  - task: lint_c_benchmarks
    status: na
  - task: lint_c_tests_fixtures
    status: na
  - task: lint_shell
    status: na
  - task: lint_typescript_declarations
    status: passed
  - task: lint_typescript_tests
    status: na
  - task: lint_license_headers
    status: passed
---

---
type: pre_push_report
description: Results of running various checks prior to pushing changes.
report:
  - task: run_javascript_examples
    status: na
  - task: run_c_examples
    status: na
  - task: run_cpp_examples
    status: na
  - task: run_javascript_readme_examples
    status: na
  - task: run_c_benchmarks
    status: na
  - task: run_cpp_benchmarks
    status: na
  - task: run_fortran_benchmarks
    status: na
  - task: run_javascript_benchmarks
    status: na
  - task: run_julia_benchmarks
    status: na
  - task: run_python_benchmarks
    status: na
  - task: run_r_benchmarks
    status: na
  - task: run_javascript_tests
    status: na
---

Author: kgryte

lib/node_modules/@stdlib/lapack/base/zlacgv/README.md

@@ -20,7 +20,7 @@ limitations under the License.
 
 # zlacgv
 
-> Conjugates a complex vector.
+> Conjugate each element in a double-precision complex floating-point vector.
 
 <section class="usage">
 
@@ -30,9 +30,9 @@ limitations under the License.
 var zlacgv = require( '@stdlib/lapack/base/zlacgv' );
 ```
 
-#### zlacgv( N, zx, strideX )
+#### zlacgv( N, zx, strideZX )
 
-Conjugate values of `zx`.
+Conjugates each element in a double-precision complex floating-point vector.
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
@@ -57,9 +57,9 @@ The function has the following parameters:
 
 -   **N**: number of indexed elements.
 -   **zx**: input [`Complex128Array`][@stdlib/array/complex128].
--   **strideX**: index increment for `zx`.
+-   **strideZX**: stride length for `zx`.
 
-The `N` and stride parameters determine how values from `zx` conjugated. For example, to conjugate every other value in `zx`,
+The `N` and stride parameters determine which elements in `zx` are conjugated. For example, to conjugate every other element in `zx`,
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
@@ -96,7 +96,7 @@ var zx0 = new Complex128Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 ] );
 // Create an offset view:
 var zx1 = new Complex128Array( zx0.buffer, zx0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
 
-// Conjugates every other value from `zx1`...
+// Conjugate every element in `zx1`:
 zlacgv( 3, zx1, 1 );
 
 var z = zx0.get( 1 );
@@ -109,9 +109,9 @@ var im = imag( z );
 // returns -4.0
 ```
 
-#### zlacgv.ndarray( N, zx, strideX, offsetX )
+#### zlacgv.ndarray( N, zx, strideZX, offsetZX )
 
-Conjugate values from `zx` using alternative indexing semantics.
+Conjugates each element in a double-precision floating-point vector using alternative indexing semantics.
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
@@ -134,9 +134,9 @@ var im = imag( z );
 
 The function has the following additional parameters:
 
--   **offsetX**: starting index for `zx`.
+-   **offsetZX**: starting index for `zx`.
 
-While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to conjugate every other value in the input strided array starting from the second element,
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameter supports indexing semantics based on a starting index. For example, to conjugate every other element in the input strided array starting from the second element,
 
 ```javascript
 var Complex128Array = require( '@stdlib/array/complex128' );
@@ -165,8 +165,8 @@ var im = imag( z );
 
 ## Notes
 
--   If `N <= 0` or `strideX <= 0` , both functions return `zx` unchanged.
--   `zlacgv()` corresponds to the [LAPACK][lapack] BLAS-like level 1 function [`zlacgv`][zlacgv].
+-   If `N <= 0`, both functions return `zx` unchanged.
+-   `zlacgv()` corresponds to the [LAPACK][lapack] BLAS-like level 1 routine [`zlacgv`][zlacgv].
 
 </section>
 
@@ -191,7 +191,7 @@ function rand() {
 var zx = filledarrayBy( 10, 'complex128', rand );
 console.log( zx.toString() );
 
-// Conjugates elements from `zx`:
+// Conjugate elements:
 zlacgv( zx.length, zx, 1 );
 console.log( zx.get( zx.length-1 ).toString() );
 ```
@@ -200,102 +200,6 @@ console.log( zx.get( zx.length-1 ).toString() );
 
 <!-- /.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/lapack/base/zlacgv.h"
-```
-
-#### c_zlacgv( N, \*ZX, strideX )
-
-Conjugate values from `ZX`.
-
-```c
-double zx[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
-
-c_zlacgv( 4, (void *)zx, 1 );
-```
-
-The function accepts the following arguments:
-
--   **N**: `[in] CBLAS_INT` number of indexed elements.
--   **ZX**: `[inout] void*` input array.
--   **strideX**: `[in] CBLAS_INT` index increment for `ZX`.
-
-```c
-void c_zlacgv( const CBLAS_INT N, void *ZX, const CBLAS_INT strideX );
-```
-
-</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/lapack/base/zlacgv.h"
-#include <stdio.h>
-
-int main( void ) {
-    // Create a strided array of interleaved real and imaginary components:
-    double zx[] = { 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0 };
-
-    // Specify the number of elements:
-    const int N = 4;
-
-    // Specify stride length:
-    const int strideX = 1;
-
-    // Conjugate elements of the array:
-    c_zlacgv( N, (void *)zx, strideX );
-
-    // Print the result:
-    for ( int i = 0; i < N; i++ ) {
-        printf( "zx[ %i ] = %f + %fj\n", i, zx[ i*2 ], zx[ (i*2)+1 ] );
-    }
-}
-```
-
-</section>
-
-<!-- /.examples -->
-
-</section>
-
-<!-- /.c -->
-
 <!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
 
 <section class="related">

lib/node_modules/@stdlib/lapack/base/zlacgv/docs/repl.txt

@@ -1,16 +1,14 @@
 
-{{alias}}( N, zx, strideX )
-    Conjugates a double-precision complex floating-point vector.
+{{alias}}( N, zx, strideZX )
+    Conjugates each element in a double-precision complex floating-point vector.
 
-    The `N` and stride parameters determine how values from `zx` are
+    The `N` and stride parameters determine which elements in `zx` are
     conjugated.
 
     Indexing is relative to the first index. To introduce an offset, use typed
     array views.
 
-    If `N` or `strideX` is less than or equal to `0`, the function returns `zx`
-    unchanged.
-
+    If `N` is less than or equal to `0`, the function returns `zx` unchanged.
 
     Parameters
     ----------
@@ -20,8 +18,8 @@
     zx: Complex128Array
         Input array.
 
-    strideX: integer
-        Index increment for `zx`.
+    strideZX: integer
+        Stride length for `zx`.
 
     Returns
     -------
@@ -59,9 +57,9 @@
     -4.0
 
 
-{{alias}}.ndarray( N, zx, strideX, offsetX )
-    Conjugates a double-precision complex floating-point vector using
-    alternative indexing semantics.
+{{alias}}.ndarray( N, zx, strideZX, offsetZX )
+    Conjugates each element in a double-precision complex floating-point vector
+    using alternative indexing semantics.
 
     While typed array views mandate a view offset based on the underlying
     buffer, the offset parameter supports indexing semantics based on a starting
@@ -75,10 +73,10 @@
     zx: Complex128Array
         Input array.
 
-    strideX: integer
-        Index increment for `zx`.
+    strideZX: integer
+        Stride length for `zx`.
 
-    offsetX: integer
+    offsetZX: integer
         Starting index for `zx`.
 
     Returns

lib/node_modules/@stdlib/lapack/base/zlacgv/docs/types/index.d.ts

@@ -27,11 +27,11 @@ import { Complex128Array } from '@stdlib/types/array';
 */
 interface Routine {
 	/**
-	* Conjugates a double-precision complex floating-point vector.
+	* Conjugates each element in a double-precision complex floating-point vector.
 	*
 	* @param N - number of indexed elements
 	* @param zx - input array
-	* @param strideX - `zx` stride length
+	* @param strideZX - `zx` stride length
 	* @returns input array
 	*
 	* @example
@@ -52,15 +52,15 @@ interface Routine {
 	* var im = imag( z );
 	* // returns -2.0
 	*/
-	( N: number, zx: Complex128Array, strideX: number ): Complex128Array;
+	( N: number, zx: Complex128Array, strideZX: number ): Complex128Array;
 
 	/**
-	* Conjugates a double-precision complex floating-point vector.
+	* Conjugates each element in a double-precision complex floating-point vector.
 	*
 	* @param N - number of indexed elements
 	* @param zx - input array
-	* @param strideX - `zx` stride length
-	* @param offsetX - starting index for `zx`
+	* @param strideZX - `zx` stride length
+	* @param offsetZX - starting index for `zx`
 	* @returns input array
 	*
 	* @example
@@ -81,15 +81,15 @@ interface Routine {
 	* var im = imag( z );
 	* // returns -2.0
 	*/
-	ndarray( N: number, zx: Complex128Array, strideX: number, offsetX: number ): Complex128Array;
+	ndarray( N: number, zx: Complex128Array, strideZX: number, offsetZX: number ): Complex128Array;
 }
 
 /**
-* Conjugates a double-precision complex floating-point vector.
+* Conjugates each element in a double-precision complex floating-point vector.
 *
 * @param N - number of indexed elements
 * @param zx - input array
-* @param strideX - `zx` stride length
+* @param strideZX - `zx` stride length
 * @returns input array
 *
 * @example

lib/node_modules/@stdlib/lapack/base/zlacgv/examples/index.js

@@ -21,7 +21,7 @@
 var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
 var filledarrayBy = require( '@stdlib/array/filled-by' );
 var Complex128 = require( '@stdlib/complex/float64/ctor' );
-var zlacgv = require( '@stdlib/lapack/base/zlacgv' );
+var zlacgv = require( './../lib' );
 
 function rand() {
 	return new Complex128( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) );
@@ -30,6 +30,6 @@ function rand() {
 var zx = filledarrayBy( 10, 'complex128', rand );
 console.log( zx.toString() );
 
-// Conjugate elements of `zx`:
+// Conjugate elements:
 zlacgv( zx.length, zx, 1 );
 console.log( zx.get( zx.length-1 ).toString() );

lib/node_modules/@stdlib/lapack/base/zlacgv/lib/index.js

@@ -19,7 +19,7 @@
 'use strict';
 
 /**
-* LAPACK BLAS-like level-1 routine to conjugate a double-precision complex floating-point vector.
+* LAPACK BLAS-like level-1 routine to conjugate each element in a double-precision complex floating-point vector.
 *
 * @module @stdlib/lapack/base/zlacgv
 *

lib/node_modules/@stdlib/lapack/base/zlacgv/lib/ndarray.js

@@ -26,12 +26,12 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
 // MAIN //
 
 /**
-* Conjugates a double-precision complex floating-point vector.
+* Conjugates each element in a double-precision complex floating-point vector.
 *
 * @param {PositiveInteger} N - number of indexed elements
 * @param {Complex128Array} zx - input array
-* @param {integer} strideX - `zx` stride length
-* @param {NonNegativeInteger} offsetX - starting `zx` index
+* @param {integer} strideZX - `zx` stride length
+* @param {NonNegativeInteger} offsetZX - starting `zx` index
 * @returns {Complex128Array} input array
 *
 * @example
@@ -52,29 +52,27 @@ var reinterpret = require( '@stdlib/strided/base/reinterpret-complex128' );
 * var im = imag( z );
 * // returns -2.0
 */
-function zlacgv( N, zx, strideX, offsetX ) {
+function zlacgv( N, zx, strideZX, offsetZX ) {
 	var zx64;
 	var ix;
 	var sx;
 	var i;
 
-	if ( N <= 0 || strideX <= 0 ) {
+	if ( N <= 0 ) {
 		return zx;
 	}
-
-	// Interpret the complex input array as a float64 array
+	// Reinterpret the input array as a real-valued array of interleaved real and imaginary components:
 	zx64 = reinterpret( zx, 0 );
 
-	// Compute a stride and an index to be incremented
-	sx = strideX*2;
-	ix = (offsetX*2) + 1;
+	// Adjust the strides and offset:
+	sx = strideZX * 2;
+	ix = ( offsetZX * 2 ) + 1; // index of the first imaginary component
 
-	// Conjugate the complex elements
+	// Conjugate each element by negating the imaginary components...
 	for ( i = 0; i < N; i++ ) {
 		zx64[ ix ] = -zx64[ ix ];
 		ix += sx;
 	}
-
 	return zx;
 }