hipblasnrm2ex Interface Reference

hipblasnrm2ex Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasnrm2ex Interface Reference
hipfort_hipblas::hipblasnrm2ex Interface Reference

BLAS EX API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasnrm2ex_ (handle, n, x, xtype, incx, myresult, resulttype, executiontype)
 

Detailed Description

BLAS EX API.

The nrm2Ex functions compute the Euclidean norm of a real or complex vector:

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

The supported types are determined by the backend. See the rocBLAS or cuBLAS documentation.

Parameters
[in]handle- [hipblasHandle_t] handle to the hipBLAS library context queue.
[in]n- [int] the number of elements in x.
[in]x- device pointer storing vector x.
[in]xType[hipDataType] specifies the datatype of the vector x.
[in]incx- [int] specifies the increment for the elements of y.
[in,out]myResultdevice pointer or host pointer to store the nrm2 product. The return value is 0.0 if n, incx<=0.
[in]resultType[hipDataType] specifies the datatype of the result.
[in]executionType[hipDataType] specifies the datatype of computation.

Member Function/Subroutine Documentation

◆ hipblasnrm2ex_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasnrm2ex::hipblasnrm2ex_ ( type(c_ptr), value  handle,
integer(c_int), value  n,
type(c_ptr), value  x,
integer(kind(hip_r_32f)), value  xtype,
integer(c_int), value  incx,
type(c_ptr), value  myresult,
integer(kind(hip_r_32f)), value  resulttype,
integer(kind(hip_r_32f)), value  executiontype 
)

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