rocsolver_sormtr Interface Reference

rocsolver_sormtr Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_sormtr Interface Reference

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


integer(kind(rocblas_status_success)) function	rocsolver_sormtr_orig (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)

integer(kind(rocblas_status_success)) function	rocsolver_sormtr_rank_0 (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)

integer(kind(rocblas_status_success)) function	rocsolver_sormtr_rank_1 (handle, side, uplo, trans, m, n, A, lda, ipiv, C, ldc)

Detailed Description

!

ORMTR applies an orthogonal matrix Q to a general m-by-n matrix C.

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.

Q is defined as the product of nq-1 Householder reflectors of order nq. If uplo indicates upper, then Q has the form

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

On the other hand, if uplo indicates lower, then Q has the form

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 SYTRD in its arguments A and tau.

Parameters

[in]	handle	rocblas_handle.
[in]	side	rocblas_side. Specifies from which side to apply Q.
[in]	uplo	rocblas_fill. Specifies whether the SYTRD factorization was upper or lower triangular. If uplo indicates lower (or upper), then the upper (or lower) part of A is not used.
[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]	A	pointer to type. Array on the GPU of size ldanq. On entry, the (i+1)-th column (if uplo indicates upper) or i-th column (if uplo indicates lower) has the Householder vector v(i) as returned by SYTRD.
[in]	lda	rocblas_int. lda >= nq. Leading dimension of A.
[in]	ipiv	pointer to type. Array on the GPU of dimension at least nq-1. The scalar factors of the Householder matrices H(i) as returned by SYTRD.
[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_sormtr_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_full_rank	(	type(c_ptr), value	handle,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_fill_upper)), value	uplo,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		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_sormtr_orig()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_orig	(	type(c_ptr), value	handle,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_fill_upper)), value	uplo,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		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_sormtr_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_rank_0	(	type(c_ptr), value	handle,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_fill_upper)), value	uplo,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		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_sormtr_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sormtr::rocsolver_sormtr_rank_1	(	type(c_ptr), value	handle,
		integer(kind(rocblas_side_left)), value	side,
		integer(kind(rocblas_fill_upper)), value	uplo,
		integer(kind(rocblas_operation_none)), value	trans,
		integer(c_int), value	m,
		integer(c_int), value	n,
		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