hipblassnrm2stridedbatched Interface Reference

hipblassnrm2stridedbatched Interface Reference#

HIPFORT API Reference: hipfort_hipblas::hipblassnrm2stridedbatched Interface Reference
hipfort_hipblas::hipblassnrm2stridedbatched Interface Reference

BLAS Level 1 API. More...

Public Member Functions

integer(kind(hipblas_status_success)) function hipblassnrm2stridedbatched_ (handle, n, x, incx, stridex, batchcount, myresult)
 
integer(kind(hipblas_status_success)) function hipblassnrm2stridedbatched_rank_0 (handle, n, x, incx, stridex, batchcount, myresult)
 
integer(kind(hipblas_status_success)) function hipblassnrm2stridedbatched_rank_1 (handle, n, x, incx, stridex, batchcount, myresult)
 

Detailed Description

BLAS Level 1 API.

The nrm2StridedBatched functions compute 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
  • Supported precisions in rocBLAS : s, d, c, z, sc, and dz.
  • Supported precisions in cuBLAS : No support.
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]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) to 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. Return value is 0.0 for each element if n <= 0, incx<=0.

Member Function/Subroutine Documentation

◆ hipblassnrm2stridedbatched_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassnrm2stridedbatched::hipblassnrm2stridedbatched_ ( type(c_ptr), value  handle,
integer(c_int), value  n,
type(c_ptr), value  x,
integer(c_int), value  incx,
integer(c_int64_t), value  stridex,
integer(c_int), value  batchcount,
type(c_ptr), value  myresult 
)

◆ hipblassnrm2stridedbatched_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassnrm2stridedbatched::hipblassnrm2stridedbatched_rank_0 ( type(c_ptr)  handle,
integer(c_int)  n,
real(c_float), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
integer(c_int)  batchcount,
type(c_ptr)  myresult 
)

◆ hipblassnrm2stridedbatched_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassnrm2stridedbatched::hipblassnrm2stridedbatched_rank_1 ( type(c_ptr)  handle,
integer(c_int)  n,
real(c_float), dimension(:), target  x,
integer(c_int)  incx,
integer(c_int64_t)  stridex,
integer(c_int)  batchcount,
type(c_ptr)  myresult 
)

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