Blas/base/cgemv

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

@@ -0,0 +1,295 @@
+<!--
+
+@license Apache-2.0
+
+Copyright (c) 2024 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.
+
+-->
+
+# cgemv
+
+> Perform one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y` for complex-valued data.
+
+<section class="usage">
+
+## Usage
+
+```javascript
+var cgemv = require( '@stdlib/blas/base/cgemv' );
+```
+
+#### cgemv( order, trans, M, N, α, A, LDA, x, sx, β, y, sy )
+
+Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y` where `α` and `β` are complex scalars, `x` and `y` are complex vectors, and `A` is an `M` by `N` complex matrix.
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+
+var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ] );
+var x = new Complex64Array( [ 1.0, 0.0, 1.0, 0.0 ] );
+var y = new Complex64Array( [ 1.0, 0.0, 1.0, 0.0 ] );
+
+var alpha = new Complex64( 1.0, 0.0 );
+var beta = new Complex64( 1.0, 0.0 );
+
+cgemv( 'row-major', 'no-transpose', 2, 2, alpha, A, 2, x, 1, beta, y, 1 );
+// y => <Complex64Array>[ 4.0, 0.0, 8.0, 0.0 ]
+```
+
+The function has the following parameters:
+
+-   **order**: storage layout.
+-   **trans**: specifies whether `A` should be transposed, conjugate-transposed, or not transposed.
+-   **M**: number of rows in the matrix `A`.
+-   **N**: number of columns in the matrix `A`.
+-   **α**: complex scalar constant.
+-   **A**: input matrix stored in linear memory as a [`Complex64Array`][@stdlib/array/complex64].
+-   **LDA**: stride of the first dimension of `A` (a.k.a., leading dimension of the matrix `A`).
+-   **x**: input [`Complex64Array`][@stdlib/array/complex64].
+-   **sx**: stride length for `x`.
+-   **β**: complex scalar constant.
+-   **y**: output [`Complex64Array`][@stdlib/array/complex64].
+-   **sy**: stride length for `y`.
+
+The stride parameters determine how elements are accessed. For example, to iterate over every other element in `x` and `y`,
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+
+var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0 ] );
+var x = new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0 ] );
+var y = new Complex64Array( [ 1.0, 0.0, 0.0, 0.0, 1.0, 0.0, 0.0, 0.0 ] );
+
+var alpha = new Complex64( 1.0, 0.0 );
+var beta = new Complex64( 1.0, 0.0 );
+
+cgemv( 'row-major', 'no-transpose', 2, 2, alpha, A, 2, x, 2, beta, y, 2 );
+// y => <Complex64Array>[ 4.0, 0.0, 0.0, 0.0, 8.0, 0.0, 0.0, 0.0 ]
+```
+
+Note that indexing is relative to the first index. To introduce an offset, use [`typed array`][mdn-typed-array] views.
+
+<!-- eslint-disable stdlib/capitalized-comments -->
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+
+// Initial arrays...
+var x0 = new Complex64Array( [ 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] );
+var y0 = new Complex64Array( [ 0.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] );
+var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0, 5.0, 0.0, 6.0, 0.0 ] );
+
+var alpha = new Complex64( 1.0, 0.0 );
+var beta = new Complex64( 1.0, 0.0 );
+
+// Create offset views...
+var x1 = new Complex64Array( x0.buffer, x0.BYTES_PER_ELEMENT*2 ); // start at 2nd complex element
+var y1 = new Complex64Array( y0.buffer, y0.BYTES_PER_ELEMENT*2 ); // start at 2nd complex element
+
+cgemv( 'row-major', 'no-transpose', 2, 2, alpha, A, 2, x1, -1, beta, y1, -1 );
+// y0 => <Complex64Array>[ 0.0, 0.0, 8.0, 0.0, 4.0, 0.0 ]
+```
+
+<!-- lint disable maximum-heading-length -->
+
+#### cgemv.ndarray( trans, M, N, α, A, sa1, sa2, oa, x, sx, ox, β, y, sy, oy )
+
+Performs one of the matrix-vector operations `y = α*A*x + β*y` or `y = α*A^T*x + β*y` using alternative indexing semantics and where `α` and `β` are complex scalars, `x` and `y` are complex vectors, and `A` is an `M` by `N` complex matrix.
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+
+var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0, 5.0, 0.0, 6.0, 0.0 ] );
+var x = new Complex64Array( [ 1.0, 0.0, 1.0, 0.0, 1.0, 0.0 ] );
+var y = new Complex64Array( [ 1.0, 0.0, 1.0, 0.0 ] );
+
+var alpha = new Complex64( 1.0, 0.0 );
+var beta = new Complex64( 1.0, 0.0 );
+
+cgemv.ndarray( 'no-transpose', 2, 3, alpha, A, 3, 1, 0, x, 1, 0, beta, y, 1, 0 );
+// y => <Complex64Array>[ 7.0, 0.0, 16.0, 0.0 ]
+```
+
+The function has the following additional parameters:
+
+-   **sa1**: stride of the first dimension of `A`.
+-   **sa2**: stride of the second dimension of `A`.
+-   **oa**: starting index for `A`.
+-   **ox**: starting index for `x`.
+-   **oy**: starting index for `y`.
+
+While [`typed array`][mdn-typed-array] views mandate a view offset based on the underlying buffer, the offset parameters support indexing semantics based on starting indices. For example,
+
+```javascript
+var Complex64Array = require( '@stdlib/array/complex64' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+
+var A = new Complex64Array( [ 1.0, 0.0, 2.0, 0.0, 3.0, 0.0, 4.0, 0.0, 5.0, 0.0, 6.0, 0.0 ] );
+var x = new Complex64Array( [ 0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 3.0, 0.0 ] );
+var y = new Complex64Array( [ 7.0, 0.0, 8.0, 0.0, 9.0, 0.0, 10.0, 0.0 ] );
+
+var alpha = new Complex64( 1.0, 0.0 );
+var beta = new Complex64( 1.0, 0.0 );
+
+cgemv.ndarray( 'no-transpose', 2, 3, alpha, A, 3, 1, 0, x, 1, 1, beta, y, -2, 2 );
+// y => <Complex64Array>[ 39.0, 0.0, 8.0, 0.0, 23.0, 0.0, 10.0, 0.0 ]
+```
+
+</section>
+
+<!-- /.usage -->
+
+<section class="notes">
+
+## Notes
+
+-   `cgemv()` corresponds to the [BLAS][blas] level 2 function [`cgemv`][cgemv].
+
+</section>
+
+<!-- /.notes -->
+
+<section class="examples">
+
+## Examples
+
+<!-- eslint no-undef: "error" -->
+
+```javascript
+var discreteUniform = require( '@stdlib/random/base/discrete-uniform' );
+var Complex64 = require( '@stdlib/complex/float32/ctor' );
+var filledarrayBy = require( '@stdlib/array/filled-by' );
+var logEach = require( '@stdlib/console/log-each' );
+var cgemv = require( '@stdlib/blas/base/cgemv' );
+
+function rand() {
+    return new Complex64( discreteUniform( 0, 255 ), discreteUniform( -128, 127 ) );
+}
+
+var M = 3;
+var N = 3;
+
+var A = filledarrayBy( M*N, 'complex64', rand );
+var x = filledarrayBy( N, 'complex64', rand );
+var y = filledarrayBy( M, 'complex64', rand );
+
+var alpha = new Complex64( 1.0, 0.0 );
+var beta = new Complex64( 1.0, 0.0 );
+
+cgemv( 'row-major', 'no-transpose', M, N, alpha, A, N, x, -1, beta, y, -1 );
+console.log( y );
+```
+
+</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
+TODO
+```
+
+#### TODO
+
+TODO.
+
+```c
+TODO
+```
+
+TODO
+
+```c
+TODO
+```
+
+</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
+TODO
+```
+
+</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
+
+[cgemv]: https://www.netlib.org/lapack/explore-html/d7/dda/group__gemv_ga44c85a0d7ecd60a6bc8ca27b222d7792.html#ga44c85a0d7ecd60a6bc8ca27b222d7792
+
+[mdn-typed-array]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray
+
+[@stdlib/array/complex64]: https://github.com/stdlib-js/stdlib/tree/develop/lib/node_modules/%40stdlib/array/complex64
+
+</section>
+
+<!-- /.links -->