rocsolver_sgebrd_batched Interface Reference

rocsolver_sgebrd_batched Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_sgebrd_batched Interface Reference
hipfort_rocsolver::rocsolver_sgebrd_batched Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_sgebrd_batched_full_rank (handle, m, n, A, lda, D, strideD, E, strideE, tauq, strideQ, taup, strideP, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_sgebrd_batched_orig (handle, m, n, A, lda, D, strideD, E, strideE, tauq, strideQ, taup, strideP, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_sgebrd_batched_rank_0 (handle, m, n, A, lda, D, strideD, E, strideE, tauq, strideQ, taup, strideP, batch_count)
 
integer(kind(rocblas_status_success)) function rocsolver_sgebrd_batched_rank_1 (handle, m, n, A, lda, D, strideD, E, strideE, tauq, strideQ, taup, strideP, batch_count)
 

Detailed Description

!

GEBRD_BATCHED computes the bidiagonal form of a batch of general m-by-n matrices.

(This is the blocked version of the algorithm).

The bidiagonal form is given by:

B_j = Q_j'  A_j  P_j

where B_j is upper bidiagonal if m >= n and lower bidiagonal if m < n, and Q_j and P_j are orthogonalunitary matrices represented as the product of Householder matrices

Q_j = H_j(1)  H_j(2)  ...   H_j(n)  and P_j = G_j(1)  G_j(2)  ...  G_j(n-1), if m >= n, or
Q_j = H_j(1)  H_j(2)  ...  H_j(m-1) and P_j = G_j(1)  G_j(2)  ...   G_j(m),  if m < n

Each Householder matrix H_j(i) and G_j(i), for j = 1,2,...,batch_count, is given by

H_j(i) = I - tauq_j[i-1]  v_j(i)  v_j(i)', and
G_j(i) = I - taup_j[i-1]  u_j(i)  u_j(i)'

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

Parameters
[in]handlerocblas_handle.
[in]mrocblas_int. m >= 0.
The number of rows of all the matrices A_j in the batch.
[in]nrocblas_int. n >= 0.
The number of columns of all the matrices A_j in the batch.
[in,out]AArray of pointers to type. Each pointer points to an array on the GPU of dimension ldan.
On entry, the m-by-n matrices A_j 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_j. If m >= n, the elements below the diagonal are the m - i elements of vector v_j(i) for i = 1,2,...,n, and the elements above the superdiagonal are the n - i - 1 elements of vector u_j(i) for i = 1,2,...,n-1. If m < n, the elements below the subdiagonal are the m - i - 1 elements of vector v_j(i) for i = 1,2,...,m-1, and the elements above the diagonal are the n - i elements of vector u_j(i) for i = 1,2,...,m.
[in]ldarocblas_int. lda >= m.
Specifies the leading dimension of matrices A_j.
[out]Dpointer to real type. Array on the GPU (the size depends on the value of strideD).
The diagonal elements of B_j.
[in]strideDrocblas_stride.
Stride from the start of one vector D_j and the next one D_(j+1). There is no restriction for the value of strideD. Normal use case is strideD >= min(m,n).
[out]Epointer to real type. Array on the GPU (the size depends on the value of strideE).
The off-diagonal elements of B_j.
[in]strideErocblas_stride.
Stride from the start of one vector E_j and the next one E_(j+1). There is no restriction for the value of strideE. Normal use case is strideE >= min(m,n)-1.
[out]tauqpointer to type. Array on the GPU (the size depends on the value of strideQ).
Contains the vectors tauq_j of scalar factors of the Householder matrices H_j(i).
[in]strideQrocblas_stride.
Stride from the start of one vector tauq_j to the next one tauq_(j+1). There is no restriction for the value of strideQ. Normal use is strideQ >= min(m,n).
[out]tauppointer to type. Array on the GPU (the size depends on the value of strideP).
Contains the vectors taup_j of scalar factors of the Householder matrices G_j(i).
[in]strideProcblas_stride.
Stride from the start of one vector taup_j to the next one taup_(j+1). There is no restriction for the value of strideP. Normal use is strideP >= min(m,n).
[in]batch_countrocblas_int. batch_count >= 0.
Number of matrices in the batch.

Member Function/Subroutine Documentation

◆ rocsolver_sgebrd_batched_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebrd_batched::rocsolver_sgebrd_batched_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,
integer(c_int64_t), value  strideD,
real(c_float), dimension(:), target  E,
integer(c_int64_t), value  strideE,
real(c_float), dimension(:), target  tauq,
integer(c_int64_t), value  strideQ,
real(c_float), dimension(:), target  taup,
integer(c_int64_t), value  strideP,
integer(c_int), value  batch_count 
)

◆ rocsolver_sgebrd_batched_orig()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebrd_batched::rocsolver_sgebrd_batched_orig ( type(c_ptr), value  handle,
integer(c_int), value  m,
integer(c_int), value  n,
type(c_ptr)  A,
integer(c_int), value  lda,
type(c_ptr), value  D,
integer(c_int64_t), value  strideD,
type(c_ptr), value  E,
integer(c_int64_t), value  strideE,
type(c_ptr), value  tauq,
integer(c_int64_t), value  strideQ,
type(c_ptr), value  taup,
integer(c_int64_t), value  strideP,
integer(c_int), value  batch_count 
)

◆ rocsolver_sgebrd_batched_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebrd_batched::rocsolver_sgebrd_batched_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,
integer(c_int64_t), value  strideD,
real(c_float), target  E,
integer(c_int64_t), value  strideE,
real(c_float), target  tauq,
integer(c_int64_t), value  strideQ,
real(c_float), target  taup,
integer(c_int64_t), value  strideP,
integer(c_int), value  batch_count 
)

◆ rocsolver_sgebrd_batched_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_sgebrd_batched::rocsolver_sgebrd_batched_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,
integer(c_int64_t), value  strideD,
real(c_float), dimension(:), target  E,
integer(c_int64_t), value  strideE,
real(c_float), dimension(:), target  tauq,
integer(c_int64_t), value  strideQ,
real(c_float), dimension(:), target  taup,
integer(c_int64_t), value  strideP,
integer(c_int), value  batch_count 
)

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