gemm_bias

Computes a matrix-matrix product using general integer matrices with bias.

gemm_bias supports the following precisions.

Ts	Ta	Tb	Tc
float	std::uint8_t	std::uint8_t	std::int32_t
float	std::int8_t	std::uint8_t	std::int32_t
float	std::uint8_t	std::int8_t	std::int32_t
float	std::int8_t	std::int8_t	std::int32_t

Description

The gemm_bias routines compute a scalar-matrix-matrix product and add the result to a scalar-matrix product, using general integer matrices with biases/offsets. The operation is defined as:

C ← alpha*(op(A) - A_offset)*(op(B) - B_offset) + beta*C + C_offset

where:

op(X) is one of op(X) = X, or op(X) = X^T, or op(X) = X^H

alpha and beta are scalars

A_offset is an m-by-k matrix with every element equal to the value ao

B_offset is a k-by-n matrix with every element equal to the value bo

C_offset is an m-by-n matrix defined by the co buffer as described below.

A, B, and C are matrices

op(A) is m x k, op(B) is k x n, and C is m x n.

gemm_bias (Buffer Version)

Syntax

void onemkl::blas::gemm_bias(sycl::queue &queue, onemkl::transpose transa, onemkl::transpose transb, onemkl::offset offset_type, std::int64_t m, std::int64_t n, std::int64_t k, Ts alpha, sycl::buffer<Ta, 1> &a, std::int64_t lda, Ta ao, sycl::buffer<Tb, 1> &b, std::int64_t ldb, Tb bo, Ts beta, sycl::buffer<Tc, 1> &c, std::int64_t ldc, sycl::buffer<Tc, 1> &co)

Input Parameters

queue

The queue where the routine should be executed.

transa

Specifies op(A), the transposition operation applied to A. See oneMKL defined datatypes for more details.

transb

Specifies op(B), the transposition operation applied to B. See oneMKL defined datatypes for more details.

offset_type

Specifies the form of C_offset used in the matrix multiplication. See oneMKL defined datatypes for more details.

m

Number of rows of op(A) and C. Must be at least zero.

n

Number of columns of op(B) and C. Must be at least zero.

k

Number of columns of op(A) and rows of op(B). Must be at least zero.

alpha

Scaling factor for the matrix-matrix product.

a

Buffer holding the input matrix A.

If A is not transposed, A is an m-by-k matrix so the array a must have size at least lda*k.

If A is transposed, A is a k-by-m matrix so the array a must have size at least lda*m.

See Matrix Storage for more details.

lda

Leading dimension of A. Must be at least m if A is not transposed, and at least k if A is transposed. Must be positive.

ao

Specifies the scalar offset value for matrix A.

b

Buffer holding the input matrix B.

If B is not transposed, B is a k-by-n matrix so the array b must have size at least ldb*n.

If B is transposed, B is an n-by-k matrix so the array b must have size at least ldb*k.

See Matrix Storage for more details.

ldb

Leading dimension of B. Must be at least k if B is not transposed, and at least n if B is transposed. Must be positive.

bo

Specifies the scalar offset value for matrix B.

beta

Scaling factor for matrix C.

c

Buffer holding the input/output matrix C. Must have size at least ldc * n. See Matrix Storage for more details.

ldc

Leading dimension of C. Must be positive and at least m.

co

Buffer holding the offset values for matrix C.

If offset_type = offset::fix, the co array must have size at least 1.

If offset_type = offset::col, the co array must have size at least max(1,m).

If offset_type = offset::row, the co array must have size at least max(1,n).

Output Parameters

c

Output buffer, overwritten by alpha*(op(A) - A_offset)*(op(B) - B_offset) + beta*C + C_offset.

Notes

If beta = 0, matrix C does not need to be initialized before calling gemm_bias.

gemm_bias (USM Version)

Syntax

sycl::event onemkl::blas::gemm_bias(sycl::queue &queue, onemkl::transpose transa, onemkl::transpose transb, onemkl::offset offset_type, std::int64_t m, std::int64_t n, std::int64_t k, Ts alpha, const Ta *a, std::int64_t lda, Ta ao, const Tb *b, std::int64_t ldb, Tb bo, Ts beta, Tc *c, std::int64_t ldc, const Tc *co, const sycl::vector_class<sycl::event> &dependencies = {})

Input Parameters

queue

The queue where the routine should be executed.

transa

Specifies op(A), the transposition operation applied to A. See oneMKL defined datatypes for more details.

transb

Specifies op(B), the transposition operation applied to B. See oneMKL defined datatypes for more details.

offset_type

Specifies the form of C_offset used in the matrix multiplication. See oneMKL defined datatypes for more details.

m

Number of rows of op(A) and C. Must be at least zero.

n

Number of columns of op(B) and C. Must be at least zero.

k

Number of columns of op(A) and rows of op(B). Must be at least zero.

alpha

Scaling factor for the matrix-matrix product.

a

Pointer to input matrix A.

If A is not transposed, A is an m-by-k matrix so the array a must have size at least lda*k.

If A is transposed, A is a k-by-m matrix so the array a must have size at least lda*m.

See Matrix Storage for more details.

lda

Leading dimension of A. Must be at least m if A is not transposed, and at least k if A is transposed. Must be positive.

ao

Specifies the scalar offset value for matrix A.

b

Pointer to input matrix B.

If B is not transposed, B is a k-by-n matrix so the array b must have size at least ldb*n.

If B is transposed, B is an n-by-k matrix so the array b must have size at least ldb*k.

See Matrix Storage for more details.

ldb

Leading dimension of B. Must be at least k if B is not transposed, and at least n if B is transposed. Must be positive.

bo

Specifies the scalar offset value for matrix B.

beta

Scaling factor for matrix C.

c

Pointer to input/output matrix C. Must have size at least ldc * n. See Matrix Storage for more details.

ldc

Leading dimension of C. Must be positive and at least m.

co

Pointer to offset values for matrix C.

If offset_type = offset::fix, the co array must have size at least 1.

If offset_type = offset::col, the co array must have size at least max(1,m).

If offset_type = offset::row, the co array must have size at least max(1,n).

dependencies

List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.

Output Parameters

c

Pointer to the output matrix, overwritten by alpha*(op(A) - A_offset)*(op(B) - B_offset) + beta*C + C_offset.

Notes

If beta = 0, matrix C does not need to be initialized before calling gemm_bias.

Return Values

Output event to wait on to ensure computation is complete.

Parent topic: BLAS-like Extensions