rocsolver_sgebd2 Interface Reference

rocsolver_sgebd2 Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_sgebd2 Interface Reference
hipfort_rocsolver::rocsolver_sgebd2 Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_sgebd2_full_rank (handle, m, n, A, lda, D, E, tauq, taup)
 
integer(kind(rocblas_status_success)) function rocsolver_sgebd2_orig (handle, m, n, A, lda, D, E, tauq, taup)
 
integer(kind(rocblas_status_success)) function rocsolver_sgebd2_rank_0 (handle, m, n, A, lda, D, E, tauq, taup)
 
integer(kind(rocblas_status_success)) function rocsolver_sgebd2_rank_1 (handle, m, n, A, lda, D, E, tauq, taup)
 

Detailed Description

!

GEBD2 computes the bidiagonal form of a general m-by-n matrix A.

(This is the unblocked version of the algorithm).

The bidiagonal form is given by:

B = Q'  A  P

where B is upper bidiagonal if m >= n and lower bidiagonal if m < n, and Q and P are orthogonalunitary matrices represented as the product of Householder matrices

Q = H(1)  H(2)  ...   H(n)  and P = G(1)  G(2)  ...  G(n-1), if m >= n, or
Q = H(1)  H(2)  ...  H(m-1) and P = G(1)  G(2)  ...   G(m),  if m < n

Each Householder matrix H(i) and G(i) is given by

H(i) = I - tauq[i-1]  v(i)  v(i)', and
G(i) = I - taup[i-1]  u(i)  u(i)'

If m >= n, the first i-1 elements of the Householder vector v(i) are zero, and v(i)[i] = 1; while the first i elements of the Householder vector u(i) are zero, and u(i)[i+1] = 1. If m < n, the first i elements of the Householder vector v(i) are zero, and v(i)[i+1] = 1; while the first i-1 elements of the Householder vector u(i) are zero, and u(i)[i] = 1.

Parameters
[in]handlerocblas_handle.
[in]mrocblas_int. m >= 0.
The number of rows of the matrix A.
[in]nrocblas_int. n >= 0.
The number of columns of the matrix A.
[in,out]Apointer to type. Array on the GPU of dimension ldan.
On entry, the m-by-n matrix to be factored. On exit, the elements on the diagonal and superdiagonal (if m >= n), or subdiagonal (if m < n) contain the bidiagonal form B. If m >= n, the elements below the diagonal are the m - i elements of vector v(i) for i = 1,2,...,n, and the elements above the superdiagonal are the n - i - 1 elements of vector u(i) for i = 1,2,...,n-1. If m < n, the elements below the subdiagonal are the m - i - 1 elements of vector v(i) for i = 1,2,...,m-1, and the elements above the diagonal are the n - i elements of vector u(i) for i = 1,2,...,m.
[in]ldarocblas_int. lda >= m.
specifies the leading dimension of A.
[out]Dpointer to real type. Array on the GPU of dimension min(m,n).
The diagonal elements of B.
[out]Epointer to real type. Array on the GPU of dimension min(m,n)-1.
The off-diagonal elements of B.
[out]tauqpointer to type. Array on the GPU of dimension min(m,n).
The scalar factors of the Householder matrices H(i).
[out]tauppointer to type. Array on the GPU of dimension min(m,n).
The scalar factors of the Householder matrices G(i).

Member Function/Subroutine Documentation

◆ rocsolver_sgebd2_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebd2::rocsolver_sgebd2_full_rank ( type(c_ptr), value  handle,
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  D,
real(c_float), dimension(:), target  E,
real(c_float), dimension(:), target  tauq,
real(c_float), dimension(:), target  taup 
)

◆ rocsolver_sgebd2_orig()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebd2::rocsolver_sgebd2_orig ( type(c_ptr), value  handle,
integer(c_int), value  m,
integer(c_int), value  n,
type(c_ptr), value  A,
integer(c_int), value  lda,
type(c_ptr), value  D,
type(c_ptr), value  E,
type(c_ptr), value  tauq,
type(c_ptr), value  taup 
)

◆ rocsolver_sgebd2_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebd2::rocsolver_sgebd2_rank_0 ( type(c_ptr), value  handle,
integer(c_int), value  m,
integer(c_int), value  n,
real(c_float), target  A,
integer(c_int), value  lda,
real(c_float), target  D,
real(c_float), target  E,
real(c_float), target  tauq,
real(c_float), target  taup 
)

◆ rocsolver_sgebd2_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebd2::rocsolver_sgebd2_rank_1 ( type(c_ptr), value  handle,
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  D,
real(c_float), dimension(:), target  E,
real(c_float), dimension(:), target  tauq,
real(c_float), dimension(:), target  taup 
)

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