This page contains proposed changes for a future release of ROCm. Read the latest Linux release of ROCm documentation for your production environments.

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

BLAS EX API. 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.

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      |
--------------------------------------------------
Parameters
[in]handle[rocblas_handle] handle to the rocblas library context queue.
[in]n[rocblas_int] the number of elements in x and y.
[in]xdevice pointer storing vector x.
[in]x_type[rocblas_datatype] specifies the datatype of vector x.
[in]incx[rocblas_int] specifies the increment for the elements of y.
[in]ydevice pointer storing vector y.
[in]y_type[rocblas_datatype] specifies the datatype of vector y.
[in]incy[rocblas_int] specifies the increment for the elements of y.
[in,out]resultdevice pointer or host pointer to store the dot product. return is 0.0 if n <= 0.
[in]result_type[rocblas_datatype] specifies the datatype of the result.
[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: