feat: add blas/base/icamax

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

@@ -0,0 +1,295 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2026 The Stdlib Authors.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+-->
+
+# icamax
+
+> Find the index of the first element having maximum |Re(.)| + |Im(.)|.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var icamax = require( '@stdlib/blas/base/icamax' );
+```
+
+#### icamax( N, x, strideX )
+
+Finds the index of the first element having maximum |Re(.)| + |Im(.)|.
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+
+var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
+
+var idx = icamax( x.length, x, 1 );
+// returns 1
+```
+
+The function has the following parameters:
+
+-   **N**: number of indexed elements.
+-   **x**: input [`Complex64Array`][@stdlib/array/complex64].
+-   **strideX**: index increment for `x`.
+
+The `N` and `strideX` parameters determine which elements in `x` are accessed at runtime. For example, to traverse every other value,
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+
+var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
+
+var idx = icamax( 2, x, 2 );
+// returns 1
+```
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+
+// Initial array:
+var x0 = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0 ] );
+
+// Create an offset view:
+var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*1 ); // start at 2nd element
+
+// Find index of element having the maximum |Re(.)| + |Im(.)|:
+var idx = icamax( 2, x1, 1 );
+// returns 1
+```
+
+#### icamax.ndarray( N, x, strideX, offsetX )
+
+Finds the index of the first element having maximum |Re(.)| + |Im(.)| using alternative indexing semantics.
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+
+var x = new Complex64Array( [ -2.0, 1.0, 3.0, -5.0, 4.0, 0.0, -1.0, -3.0 ] );
+
+var idx = icamax.ndarray( x.length, x, 1, 0 );
+// returns 1
+```
+
+The function has the following additional parameters:
+
+-   **offsetX**: starting index.
+
+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 start from the second index,
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+
+var x = new Complex64Array( [ 1.0, -2.0, 3.0, -4.0, 5.0, -6.0, 7.0, -8.0 ] );
+
+var idx = icamax.ndarray( 3, x, 1, 1 );
+// returns 2
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   If `N < 1`, both functions return `-1`.
+-   `icamax()` corresponds to the [BLAS][blas] level 1 function [`icamax`][icamax].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+var icamax = require( '@stdlib/blas/base/icamax' );
+
+function rand() {
+    return new Complex64( discreteUniform( 0, 10 ), discreteUniform( -5, 5 ) );
+}
+
+// Generate random input arrays:
+var x = filledarrayBy( 10, 'complex64', rand );
+console.log( x.toString() );
+
+var idx = icamax( x.length, x, 1 );
+console.log( idx );
+```
+
+</section>
+
+<!-- /.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/base/icamax.h"
+```
+
+#### c_icamax( N, \*X, strideX )
+
+Finds the index of the first element having maximum |Re(.)| + |Im(.)|.
+
+```c
+const float x[] = { 4.0f, 2.0f, -3.0f, 5.0f, -1.0f, 2.0f };
+
+CBLAS_INT idx = c_icamax( 3, x, 1 );
+// returns 1
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[in] void*` input array.
+-   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+
+```c
+CBLAS_INT c_icamax( const CBLAS_INT N, const void *X, const CBLAS_INT strideX );
+```
+
+#### c_icamax_ndarray( N, \*X, strideX, offsetX )
+
+Finds the index of the first element having maximum |Re(.)| + |Im(.)| using alternative indexing semantics.
+
+```c
+const float x[] = { 4.0f, 2.0f, -3.0f, 5.0f, -1.0f, 2.0f };
+
+CBLAS_INT idx = c_icamax_ndarray( 3, x, 1, 0 );
+// returns 1
+```
+
+The function accepts the following arguments:
+
+-   **N**: `[in] CBLAS_INT` number of indexed elements.
+-   **X**: `[in] void*` input array.
+-   **strideX**: `[in] CBLAS_INT` index increment for `X`.
+-   **offsetX**: `[in] CBLAS_INT` starting index for `X`.
+
+```c
+CBLAS_INT c_icamax_ndarray( const CBLAS_INT N, const void *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/base/icamax.h"
+#include <stdio.h>
+
+int main( void ) {
+    // Create strided array:
+    const float x[] = { 1.0f, -2.0f, 3.0f, -4.0f, 5.0f, -6.0f, 7.0f, -8.0f };
+
+    // Specify the number of elements:
+    const int N = 4;
+
+    // Specify stride:
+    const int strideX = 1;
+
+    // Compute the index of the maximum value:
+    CBLAS_INT idx = c_icamax( N, x, strideX );
+
+    // Print the result:
+    printf( "index value: %d\n", idx );
+
+    // Compute the index of the maximum value:
+    idx = c_icamax_ndarray( N, x, -strideX, N-1 );
+
+    // Print the result:
+    printf( "index value: %d\n", idx );
+}
+```
+
+</section>
+
+<!-- /.examples -->
+
+</section>
+
+<!-- /.c -->
+
+<!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. -->
+
+<section class="related">
+
+</section>
+
+<!-- /.related -->
+
+<!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. -->
+
+<section class="links">
+
+[blas]: http://www.netlib.org/blas
+
+[icamax]: https://www.netlib.org/lapack/explore-html/dd/d52/group__iamax_gafdf273dcc3f020e2aa5c716c1b3d7265.html
+
+[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+</section>
+
+<!-- /.links -->