rocblas_nrm2_ex Interface Reference

rocblas_nrm2_ex Interface Reference#

HIPFORT API Reference: hipfort_rocblas::rocblas_nrm2_ex Interface Reference
hipfort_rocblas::rocblas_nrm2_ex Interface Reference

! More...

Public Member Functions

integer(kind(rocblas_status_success)) function rocblas_nrm2_ex_ (handle, n, x, x_type, incx, results, result_type, execution_type)
 

Detailed Description

!

BLAS_EX API

\details
nrm2_ex computes the euclidean norm of a real or complex vector

          result := sqrt( x'x ) for real vectors
          result := sqrt( xHx ) for complex vectors

Currently supported datatypes are as follows:

    -------------------------------------
    |  x_type | result | execution_type |
    |---------|--------|----------------|
    |  f16_r  |  f16_r |     f32_r      |
    |  f32_r  |  f32_r |     f32_r      |
    |  f64_r  |  f64_r |     f64_r      |
    |  f32_c  |  f32_r |     f32_r      |
    |  f64_c  |  f64_r |     f64_r      |
    -------------------------------------

@param[in]
handle    [rocblas_handle]
          handle to the rocblas library context queue.
@param[in]
n         [rocblas_int]
          the number of elements in x.
@param[in]
x         device pointer storing vector x.
@param[in]
x_type [rocblas_datatype]
       specifies the datatype of the vector x.
@param[in]
incx      [rocblas_int]
          specifies the increment for the elements of y.
@param[inout]
result
          device pointer or host pointer to store the nrm2 product.
          return is 0.0 if n, incx<=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_nrm2_ex_()

integer(kind(rocblas_status_success)) function hipfort_rocblas::rocblas_nrm2_ex::rocblas_nrm2_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  results,
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: