rocsolver_sormbr Interface Reference

rocsolver_sormbr Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_sormbr Interface Reference

Public Member Functions
integer(kind(rocblas_status_success)) function	rocsolver_sormbr_full_rank (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc)


integer(kind(rocblas_status_success)) function	rocsolver_sormbr_orig (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc)

integer(kind(rocblas_status_success)) function	rocsolver_sormbr_rank_0 (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc)

integer(kind(rocblas_status_success)) function	rocsolver_sormbr_rank_1 (handle, storev, side, trans, m, n, k, A, lda, ipiv, C, ldc)

Detailed Description

!

ORMBR applies a matrix Q with orthonormal rows or columns to a general m-by-n matrix C.

If storev is column-wise, then the matrix Q has orthonormal columns. If storev is row-wise, then the matrix Q has orthonormal rows. The matrix Q is applied in one of the following forms, depending on the values of side and trans:

Q   C  (No transpose from the left)
Q'  C  (Transpose from the left)
C  Q   (No transpose from the right), and
C  Q'  (Transpose from the right)

The order nq of orthogonal matrix Q is nq = m if applying from the left, or nq = n if applying from the right.

When storev is column-wise, if nq >= k, then Q is defined as the product of k Householder reflectors of order nq

Q = H(1)  H(2)  ...  H(k),

and if nq < k, then Q is defined as the product

Q = H(1)  H(2)  ...  H(nq-1).

When storev is row-wise, if nq > k, then Q is defined as the product of k Householder reflectors of order nq

Q = H(1)  H(2)  ...  H(k),

and if n <= k, Q is defined as the product

Q = H(1)  H(2)  ...  H(nq-1)

The Householder matrices H(i) are never stored, they are computed from its corresponding Householder vectors v(i) and scalars ipiv_i as returned by GEBRD in its arguments A and tauq or taup.

Parameters

[in]	handle	rocblas_handle.
[in]	storev	#rocblas_storev. Specifies whether to work column-wise or row-wise.
[in]	side	rocblas_side. Specifies from which side to apply Q.
[in]	trans	rocblas_operation. Specifies whether the matrix Q or its transpose is to be applied.
[in]	m	rocblas_int. m >= 0. Number of rows of matrix C.
[in]	n	rocblas_int. n >= 0. Number of columns of matrix C.
[in]	k	rocblas_int. k >= 0. The number of columns (if storev is colum-wise) or rows (if row-wise) of the original matrix reduced by GEBRD.
[in]	A	pointer to type. Array on the GPU of size ldamin(nq,k) if column-wise, or ldanq if row-wise. The i-th column (or row) has the Householder vector v(i) associated with H(i) as returned by GEBRD.
[in]	lda	rocblas_int. lda >= nq if column-wise, or lda >= min(nq,k) if row-wise. Leading dimension of A.
[in]	ipiv	pointer to type. Array on the GPU of dimension at least min(nq,k). The scalar factors of the Householder matrices H(i) as returned by GEBRD.
[in,out]	C	pointer to type. Array on the GPU of size ldcn. On input, the matrix C. On output it is overwritten with QC, CQ, Q'C, or CQ'.
[in]	ldc	rocblas_int. ldc >= m. Leading dimension of C.

Member Function/Subroutine Documentation

◆ rocsolver_sormbr_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_full_rank	(	type(c_ptr), value	handle,
		integer(kind(rocblas_column_wise)), value	storev,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		integer(c_int), value	k,
		real(c_float), dimension(:,:), target	A,
		integer(c_int), value	lda,
		real(c_float), dimension(:), target	ipiv,
		real(c_float), dimension(:,:), target	C,
		integer(c_int), value	ldc
	)

◆ rocsolver_sormbr_orig()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_orig	(	type(c_ptr), value	handle,
		integer(kind(rocblas_column_wise)), value	storev,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		integer(c_int), value	k,
		type(c_ptr), value	A,
		integer(c_int), value	lda,
		type(c_ptr), value	ipiv,
		type(c_ptr), value	C,
		integer(c_int), value	ldc
	)

◆ rocsolver_sormbr_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_rank_0	(	type(c_ptr), value	handle,
		integer(kind(rocblas_column_wise)), value	storev,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		integer(c_int), value	k,
		real(c_float), target	A,
		integer(c_int), value	lda,
		real(c_float), target	ipiv,
		real(c_float), target	C,
		integer(c_int), value	ldc
	)

◆ rocsolver_sormbr_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormbr::rocsolver_sormbr_rank_1	(	type(c_ptr), value	handle,
		integer(kind(rocblas_column_wise)), value	storev,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		integer(c_int), value	k,
		real(c_float), dimension(:), target	A,
		integer(c_int), value	lda,
		real(c_float), dimension(:), target	ipiv,
		real(c_float), dimension(:), target	C,
		integer(c_int), value	ldc
	)

The documentation for this interface was generated from the following file:

hipfort_rocsolver.f