rocblas_dot_ex Interface Reference

rocblas_dot_ex Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_dot_ex Interface Reference
hipfort_rocblas::rocblas_dot_ex Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_dot_ex_ (handle, n, x, x_type, incx, y, y_type, incy, myResult, result_type, execution_type)
 

Detailed Description

!

BLAS EX API

\details
dot_ex  performs the dot product of vectors x and y

    result = x  y;

dotc_ex  performs the dot product of the conjugate of complex vector x and complex vector y

    result = conjugate (x)  y;

    Currently supported datatypes are as follows:

    --------------------------------------------------
    | x_type | y_type | result_type | execution_type |
    |--------|--------|-------------|----------------|
    | f16_r  | f16_r  |    f16_r    |     f16_r      |
    | f16_r  | f16_r  |    f16_r    |     f32_r      |
    | bf16_r | bf16_r |    bf16_r   |     f32_r      |
    | f32_r  | f32_r  |    f32_r    |     f32_r      |
    | f64_r  | f64_r  |    f64_r    |     f64_r      |
    | f32_c  | f32_c  |    f32_c    |     f32_c      |
    | f64_c  | f64_c  |    f64_c    |     f64_c      |
    --------------------------------------------------

@param[in]
handle    [rocblas_handle]
          handle to the rocblas library context queue.
@param[in]
n         [rocblas_int]
          the number of elements in x and y.
@param[in]
x         device pointer storing vector x.
@param[in]
x_type [rocblas_datatype]
       specifies the datatype of vector x.
@param[in]
incx      [rocblas_int]
          specifies the increment for the elements of y.
@param[in]
y         device pointer storing vector y.
@param[in]
y_type [rocblas_datatype]
      specifies the datatype of vector y.
@param[in]
incy      [rocblas_int]
          specifies the increment for the elements of y.
@param[inout]
result
          device pointer or host pointer to store the dot product.
          return is 0.0 if n <= 0.
@param[in]
result_type [rocblas_datatype]
            specifies the datatype of the result.
@param[in]
execution_type [rocblas_datatype]
              specifies the datatype of computation.

Member Function/Subroutine Documentation

◆ rocblas_dot_ex_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_dot_ex::rocblas_dot_ex_ ( type(c_ptr), value  handle,
integer(c_int), value  n,
type(c_ptr), value  x,
integer(kind(rocblas_datatype_f16_r)), value  x_type,
integer(c_int), value  incx,
type(c_ptr), value  y,
integer(kind(rocblas_datatype_f16_r)), value  y_type,
integer(c_int), value  incy,
type(c_ptr), value  myResult,
integer(kind(rocblas_datatype_f16_r)), value  result_type,
integer(kind(rocblas_datatype_f16_r)), value  execution_type 
)

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