hipblasnrm2stridedbatchedex Interface Reference

hipblasnrm2stridedbatchedex Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblasnrm2stridedbatchedex Interface Reference
Public Member Functions | List of all members
hipfort_hipblas::hipblasnrm2stridedbatchedex Interface Reference

BLAS EX API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblasnrm2stridedbatchedex_ (handle, n, x, xtype, incx, stridex, batchcount, myresult, resulttype, executiontype)
 

Detailed Description

BLAS EX API.

The nrm2StridedBatchedEx computes the Euclidean norm over a batch of real or complex vectors: 

      := sqrt( x_i'*x_i ) for real vectors x, for i = 1, ..., batchCount
      := sqrt( x_i**H*x_i ) for complex vectors, for i = 1, ..., batchCount

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] number of elements in each x_i.
[in]x- device pointer to the first vector x_1.
[in]xType[hipDataType] specifies the datatype of each vector x_i.
[in]incx- [int] specifies the increment for the elements of each x_i. incx must be > 0.
[in]stridex- [hipblasStride] stride from the start of one vector (x_i) and the next one (x_i+1). There are no restrictions placed on stridex. However, the user should ensure that stridex is of an appropriate size. For a typical case, this means stridex >= n * incx.
[in]batchCount- [int] number of instances in the batch.
[out]myResultdevice pointer or host pointer to array for storing contiguous batchCount results. Returns 0.0 for each element if n <= 0, incx<=0.
[in]resultType[hipDataType] specifies the datatype of the result.
[in]executionType[hipDataType] specifies the datatype of computation.

Member Function/Subroutine Documentation

◆ hipblasnrm2stridedbatchedex_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblasnrm2stridedbatchedex::hipblasnrm2stridedbatchedex_ ( 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,
integer(c_int64_t), value  stridex,
integer(c_int), value  batchcount,
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: