switching device

Author: DivitJain26

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

@@ -0,0 +1,71 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
+var isMatrixTranspose = require( '@stdlib/blas/base/assert/is-transpose-operation' );
+var isColumnMajor = require( '@stdlib/ndarray/base/assert/is-column-major-string' );
+var stride2offset = require( '@stdlib/strided/base/stride2offset' );
+var max = require( '@stdlib/math/base/special/fast/max' );
+var scabs1 = require( '@stdlib/blas/base/scabs1' );
+var format = require( '@stdlib/string/format' );
+var base = require( './base.js' );
+
+
+// MAIN //
+
+/**
+* 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.
+*
+* @param {string} order - storage layout
+* @param {string} trans - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
+* @param {NonNegativeInteger} M - number of rows in the matrix `A`
+* @param {NonNegativeInteger} N - number of columns in the matrix `A`
+* @param {Complex64} alpha - scalar constant
+* @param {Complex64Array} A - input matrix
+* @param {PositiveInteger} LDA - stride of the first dimension of `A`
+* @param {Complex64Array} x - first input vector
+* @param {integer} strideX - `x` stride length
+* @param {Complex64} beta - scalar constant
+* @param {Complex64Array} y - second input vector
+* @param {integer} strideY - `y` stride length
+* @throws {TypeError} first argument must be a valid order
+* @throws {TypeError} second argument must be a valid transpose operation
+* @throws {RangeError} third argument must be a nonnegative integer
+* @throws {RangeError} fourth argument must be a nonnegative integer
+* @throws {RangeError} seventh argument must be a valid stride
+* @throws {RangeError} ninth argument must be non-zero
+* @throws {RangeError} twelfth argument must be non-zero
+* @returns {Complex64Array} `y`
+*
+* @example
+* var Complex64Array = require( '@stdlib/array/complex64' );
+* var Complex64 = require( '@stdlib/complex/float32/ctor' );
+*
+* var A = new Complex64Array( [ 1.0, 2.0, 3.0, 4.0, 5.0, 6.0, 7.0, 8.0, 9.0, 10.0, 11.0, 12.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( 'no-transpose', 2, 3, alpha, A, 3, 1, 0, x, 1, 0, beta, y, 1, 0 );
+* // y => <Complex64Array>[ 10.0, 12.0, 28.0, 30.0 ]
+*/