All files dgemm.native.js

100% Statements 134/134
100% Branches 35/35
100% Functions 1/1
100% Lines 134/134

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 1352x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 2x 63x 63x 63x 63x 63x 63x 4x 4x 63x 4x 4x 63x 4x 4x 63x 3x 3x 63x 3x 3x 63x 3x 3x 42x 42x 63x 20x 63x 31x 63x 11x 11x 42x 63x 20x 63x 31x 63x 11x 11x 63x 6x 6x 63x 7x 7x 63x 18x 63x 11x 11x 63x 7x 7x 22x 22x 63x 2x 2x 2x 2x 2x  
/**
* @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 isRowMajor = require( '@stdlib/ndarray/base/assert/is-row-major-string' );
var isLayout = require( '@stdlib/blas/base/assert/is-layout' );
var isMatrixTranspose = require( '@stdlib/blas/base/assert/is-transpose-operation' );
var resolveOrder = require( '@stdlib/blas/base/layout-resolve-enum' );
var resolveTrans = require( '@stdlib/blas/base/transpose-operation-resolve-enum' );
var max = require( '@stdlib/math/base/special/fast/max' );
var format = require( '@stdlib/string/format' );
var addon = require( './../src/addon.node' );
 
 
// MAIN //
 
/**
* Performs the matrix-matrix operation `C = α*op(A)*op(B) + β*C`, where `op(X)` is either `op(X) = X` or `op(X) = X^T`, `α` and `β` are scalars, and `A`, `B`, and `C` are matrices, with `op(A)` an `M` by `K` matrix, `op(B)` a `K` by `N` matrix, and `C` an `M` by `N` matrix.
*
* @param {string} order - storage layout
* @param {string} transA - specifies whether `A` should be transposed, conjugate-transposed, or not transposed
* @param {string} transB - specifies whether `B` should be transposed, conjugate-transposed, or not transposed
* @param {NonNegativeInteger} M - number of rows in `op(A)` and `C`
* @param {NonNegativeInteger} N - number of columns in `op(B)` and `C`
* @param {NonNegativeInteger} K - number of columns in `op(A)` and rows in `op(B)`
* @param {number} alpha - scalar constant
* @param {Float64Array} A - first matrix
* @param {PositiveInteger} LDA - leading dimension of `A`
* @param {Float64Array} B - second matrix
* @param {PositiveInteger} LDB - leading dimension of `B`
* @param {number} beta - scalar constant
* @param {Float64Array} C - result matrix
* @param {PositiveInteger} LDC - leading dimension of `C`
* @throws {TypeError} first argument must be a valid order
* @throws {TypeError} second argument must be a valid transpose operation
* @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} ninth argument must be a valid stride
* @throws {RangeError} eleventh argument must be a valid stride
* @throws {RangeError} fourteenth argument must be a valid stride
* @returns {Float64Array} `C`
*
* @example
* var Float64Array = require( '@stdlib/array/float64' );
*
* var A = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
* var B = new Float64Array( [ 1.0, 1.0, 0.0, 1.0 ] );
* var C = new Float64Array( [ 1.0, 2.0, 3.0, 4.0 ] );
*
* dgemm( 'row-major', 'no-transpose', 'no-transpose', 2, 2, 2, 1.0, A, 2, B, 2, 1.0, C, 2 );
* // C => <Float64Array>[ 2.0, 5.0, 6.0, 11.0 ]
*/
function dgemm( order, transA, transB, M, N, K, alpha, A, LDA, B, LDB, beta, C, LDC ) { // eslint-disable-line max-params, max-len
	var nrowsa;
	var nrowsb;
	var isrm;
	var valc;
	if ( !isLayout( order ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a valid order. Value: `%s`.', order ) );
	}
	if ( !isMatrixTranspose( transA ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a valid transpose operation. Value: `%s`.', transA ) );
	}
	if ( !isMatrixTranspose( transB ) ) {
		throw new TypeError( format( 'invalid argument. Third argument must be a valid transpose operation. Value: `%s`.', transB ) );
	}
	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 ) );
	}
	isrm = isRowMajor( order );
	if (
		( isrm && transA === 'no-transpose' ) ||
		( !isrm && transA !== 'no-transpose' )
	) {
		nrowsa = K;
	} else {
		nrowsa = M;
	}
	if (
		( isrm && transB === 'no-transpose' ) ||
		( !isrm && transB !== 'no-transpose' )
	) {
		nrowsb = N;
	} else {
		nrowsb = K;
	}
	if ( LDA < max( 1, nrowsa ) ) {
		throw new RangeError( format( 'invalid argument. Ninth argument must be greater than or equal to max(1,%d). Value: `%d`.', nrowsa, LDA ) );
	}
	if ( LDB < max( 1, nrowsb ) ) {
		throw new RangeError( format( 'invalid argument. Eleventh argument must be greater than or equal to max(1,%d). Value: `%d`.', nrowsb, LDB ) );
	}
	if ( isrm ) {
		valc = N;
	} else {
		valc = M;
	}
	if ( LDC < max( 1, valc ) ) {
		throw new RangeError( format( 'invalid argument. Fourteenth argument must be greater than or equal to max(1,%d). Value: `%d`.', valc, LDC ) );
	}
	addon( resolveOrder( order ), resolveTrans( transA ), resolveTrans( transB ), M, N, K, alpha, A, LDA, B, LDB, beta, C, LDC );
	return C;
}
 
 
// EXPORTS //
 
module.exports = dgemm;