Press n or j to go to the next uncovered block, b, p or k for the previous block.
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x | /**
* @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.
*/
/* eslint-disable max-len, max-params */
'use strict';
// MODULES //
var format = require( '@stdlib/string/format' );
var max = require( '@stdlib/math/base/special/max' );
var isOperationSide = require( '@stdlib/blas/base/assert/is-operation-side' );
var isMatrixTranspose = require( '@stdlib/blas/base/assert/is-transpose-operation' );
var base = require( './base.js' );
// MAIN //
/**
* Multiplies a general matrix by the orthogonal matrix from a bi-diagonal reduction determined by `DGEBRD` using alternative indexing semantics.
*
* ## Notes
*
* - `Q` and `P^T` are the orthogonal matrices determined by `DGEBRD` when reducing a real matrix `A` to bi-diagonal form, `A = Q * B * P^T`.
*
* - If VECT = 'Q', `DORMBR` overwrites the general real `M` by `N` matrix `C` with,
*
* - `Q * C` if SIDE = 'left' and TRANS = 'no-transpose', or
* - `Q^T * C` if SIDE = 'left' and TRANS = 'transpose', or
* - `C * Q` if SIDE = 'right' and TRANS = 'no-transpose', or
* - `C * Q^T` if SIDE = 'right' and TRANS = 'transpose'.
*
* - If VECT = 'P', `DORMBR` overwrites the general real `M` by `N` matrix `C` with,
*
* - `P * C` if SIDE = 'left' and TRANS = 'no-transpose', or
* - `P^T * C` if SIDE = 'left' and TRANS = 'transpose', or
* - `C * P` if SIDE = 'right' and TRANS = 'no-transpose', or
* - `C * P^T` if SIDE = 'right' and TRANS = 'transpose'.
*
* - If SIDE = 'left', `LWORK >= max(1,N)`.
*
* - If SIDE = 'right', `LWORK >= max(1,M)`.
*
* - For optimum performance, `LWORK >= N*NB` if SIDE = 'left', and `LWORK >= M*NB` if SIDE = 'right', where `NB` is the optimal blocksize.
*
* - If `LWORK = -1`, then a workspace query is assumed; the routine only calculates the optimal size of the `WORK` array and returns this value as the first entry of the `WORK` array.
*
* @param {string} vect - specifies whether the matrix `Q` or the matrix `P` is applied
* @param {string} side - specifies the side of multiplication with `C`
* @param {string} trans - `'no-transpose'` for `Q` or `P`, `'transpose'` for `Q^T` or `P^T`
* @param {NonNegativeInteger} M - number of rows of `C`
* @param {NonNegativeInteger} N - number of columns of `C`
* @param {NonNegativeInteger} K - number of elementary reflectors
* @param {Float64Array} A - reflector vectors from `DGEBRD`
* @param {integer} strideA1 - stride of the first dimension of `A`
* @param {integer} strideA2 - stride of the second dimension of `A`
* @param {NonNegativeInteger} offsetA - starting index for `A`
* @param {Float64Array} TAU - scalar factors of reflectors
* @param {integer} strideTAU - stride for `TAU`
* @param {NonNegativeInteger} offsetTAU - starting index for `TAU`
* @param {Float64Array} C - input/output matrix
* @param {integer} strideC1 - stride of the first dimension of `C`
* @param {integer} strideC2 - stride of the second dimension of `C`
* @param {NonNegativeInteger} offsetC - starting index for `C`
* @param {Float64Array} WORK - workspace array
* @param {integer} strideWORK - stride for `WORK`
* @param {NonNegativeInteger} offsetWORK - starting index for `WORK`
* @param {NonNegativeInteger} LWORK - dimension of the array `WORK`
* @throws {TypeError} first argument must be either `'Q'` or `'P'`
* @throws {TypeError} second argument must be a valid operation side
* @throws {TypeError} third argument must be a valid transpose operation
* @throws {RangeError} fourth argument must be a nonnegative integer
* @throws {RangeError} fifth argument must be a nonnegative integer
* @throws {RangeError} sixth argument must be a nonnegative integer
* @throws {RangeError} twenty-first argument must be a valid `LWORK` value
* @returns {integer} status code (0 if successful)
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1, 0, 0 ] );
* var TAU = new Float64Array( [ 2 ] );
* var C = new Float64Array( [ 1, 3, 5, 2, 4, 6 ] );
* var WORK = new Float64Array( 3 );
*
* var info = dormbr( 'Q', 'left', 'no-transpose', 2, 3, 1, A, 2, 1, 0, TAU, 1, 0, C, 3, 1, 0, WORK, 1, 0, 3 );
* // returns 0
* // C => <Float64Array>[ -1, -3, -5, 2, 4, 6 ]
* // WORK[ 0 ] => 96
*/
function dormbr( vect, side, trans, M, N, K, A, strideA1, strideA2, offsetA, TAU, strideTAU, offsetTAU, C, strideC1, strideC2, offsetC, WORK, strideWORK, offsetWORK, LWORK ) {
if ( vect !== 'Q' && vect !== 'P' ) {
throw new TypeError( format( 'invalid argument. First argument must be either `\'Q\'` or `\'P\'`. Value: `%s`.', vect ) );
}
if ( !isOperationSide( side ) ) {
throw new TypeError( format( 'invalid argument. Second argument must be a valid operation side. Value: `%s`.', side ) );
}
if ( !isMatrixTranspose( trans ) ) {
throw new TypeError( format( 'invalid argument. Third argument must be a valid transpose operation. Value: `%s`.', trans ) );
}
if ( M < 0 ) {
throw new RangeError( format( 'invalid argument. Fourth argument must be a nonnegative integer. Value: `%d`.', M ) );
}
if ( N < 0 ) {
throw new RangeError( format( 'invalid argument. Fifth argument must be a nonnegative integer. Value: `%d`.', N ) );
}
if ( K < 0 ) {
throw new RangeError( format( 'invalid argument. Sixth argument must be a nonnegative integer. Value: `%d`.', K ) );
}
if ( side === 'left' ) {
if ( LWORK < max( 1, N ) && LWORK !== -1 ) {
throw new RangeError( format( 'invalid argument. Twenty-first argument must be greater than or equal to `max(1, N)` when `SIDE = \'left\'`. Value: `%d`.', LWORK ) );
}
} else if ( LWORK < max( 1, M ) && LWORK !== -1 ) {
throw new RangeError( format( 'invalid argument. Twenty-first argument must be greater than or equal to `max(1, M)` when `SIDE = \'right\'`. Value: `%d`.', LWORK ) );
}
return base( vect, side, trans, M, N, K, A, strideA1, strideA2, offsetA, TAU, strideTAU, offsetTAU, C, strideC1, strideC2, offsetC, WORK, strideWORK, offsetWORK, LWORK );
}
// EXPORTS //
module.exports = dormbr;
|