rocsolver_slarf Interface Reference

rocsolver_slarf Interface Reference#

HIPFORT API Reference: hipfort_rocsolver::rocsolver_slarf Interface Reference
hipfort_rocsolver::rocsolver_slarf Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocsolver_slarf_full_rank (handle, side, m, n, x, incx, alpha, A, lda)
 
integer(kind(rocblas_status_success)) function rocsolver_slarf_orig (handle, side, m, n, x, incx, alpha, A, lda)
 
integer(kind(rocblas_status_success)) function rocsolver_slarf_rank_0 (handle, side, m, n, x, incx, alpha, A, lda)
 
integer(kind(rocblas_status_success)) function rocsolver_slarf_rank_1 (handle, side, m, n, x, incx, alpha, A, lda)
 

Detailed Description

!

LARF applies a Householder reflector H to a general matrix A.

The Householder reflector H, of order m (or n), is to be applied to a m-by-n matrix A from the left (or the right). H is given by

H = I - alpha  x  x'

where alpha is a scalar and x a Householder vector. H is never actually computed.

Parameters
[in]handlerocblas_handle.
[in]siderocblas_side.
If side = rocblas_side_left, then compute HA If side = rocblas_side_right, then compute AH
[in]mrocblas_int. m >= 0.
Number of rows of A.
[in]nrocblas_int. n >= 0.
Number of columns of A.
[in]xpointer to type. Array on the GPU of size at least (1 + (m-1)abs(incx)) if left side, or at least (1 + (n-1)abs(incx)) if right side.
The Householder vector x.
[in]incxrocblas_int. incx != 0.
Increment between to consecutive elements of x. If incx < 0, the elements of x are used in reverse order.
[in]alphapointer to type. A scalar on the GPU.
If alpha = 0, then H = I (A will remain the same, x is never used)
[in,out]Apointer to type. Array on the GPU of size ldan.
On input, the matrix A. On output it is overwritten with HA (or AH).
[in]ldarocblas_int. lda >= m.
Leading dimension of A.

Member Function/Subroutine Documentation

◆ rocsolver_slarf_full_rank()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_slarf::rocsolver_slarf_full_rank ( type(c_ptr), value  handle,
integer(kind(rocblas_side_left)), value  side,
integer(c_int), value  m,
integer(c_int), value  n,
real(c_float), dimension(:), target  x,
integer(c_int), value  incx,
real(c_float)  alpha,
real(c_float), dimension(:,:), target  A,
integer(c_int), value  lda 
)

◆ rocsolver_slarf_orig()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_slarf::rocsolver_slarf_orig ( type(c_ptr), value  handle,
integer(kind(rocblas_side_left)), value  side,
integer(c_int), value  m,
integer(c_int), value  n,
type(c_ptr), value  x,
integer(c_int), value  incx,
real(c_float)  alpha,
type(c_ptr), value  A,
integer(c_int), value  lda 
)

◆ rocsolver_slarf_rank_0()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_slarf::rocsolver_slarf_rank_0 ( type(c_ptr), value  handle,
integer(kind(rocblas_side_left)), value  side,
integer(c_int), value  m,
integer(c_int), value  n,
real(c_float), target  x,
integer(c_int), value  incx,
real(c_float)  alpha,
real(c_float), target  A,
integer(c_int), value  lda 
)

◆ rocsolver_slarf_rank_1()

integer(kind(rocblas_status_success)) function hipfort_rocsolver::rocsolver_slarf::rocsolver_slarf_rank_1 ( type(c_ptr), value  handle,
integer(kind(rocblas_side_left)), value  side,
integer(c_int), value  m,
integer(c_int), value  n,
real(c_float), dimension(:), target  x,
integer(c_int), value  incx,
real(c_float)  alpha,
real(c_float), dimension(:), target  A,
integer(c_int), value  lda 
)

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