hipblassnrm2 Interface Reference

• hipfort_hipblas
• hipblassnrm2

Public Member Functions | List of all members

hipfort_hipblas::hipblassnrm2 Interface Reference

BLAS Level 1 API. More...

Public Member Functions
integer(kind(hipblas_status_success)) function	hipblassnrm2_ (handle, n, x, incx, myresult)
integer(kind(hipblas_status_success)) function	hipblassnrm2_rank_0 (handle, n, x, incx, myresult)
integer(kind(hipblas_status_success)) function	hipblassnrm2_rank_1 (handle, n, x, incx, myresult)

Detailed Description

BLAS Level 1 API.

The nrm2 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

• Supported precisions in rocBLAS : s, d, c, z, sc, and dz.
• Supported precisions in cuBLAS : s, d, sc, and dz.

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]	incx	- [int] specifies the increment for the elements of y.
[in,out]	myResult	device pointer or host pointer to store the nrm2 product. Return value is 0.0 if n, incx<=0.

Member Function/Subroutine Documentation

◆ hipblassnrm2_()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassnrm2::hipblassnrm2_	(	type(c_ptr), value	handle,
		integer(c_int), value	n,
		type(c_ptr), value	x,
		integer(c_int), value	incx,
		type(c_ptr), value	myresult
	)

◆ hipblassnrm2_rank_0()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassnrm2::hipblassnrm2_rank_0	(	type(c_ptr)	handle,
		integer(c_int)	n,
		real(c_float), target	x,
		integer(c_int)	incx,
		type(c_ptr)	myresult
	)

◆ hipblassnrm2_rank_1()

integer(kind(hipblas_status_success)) function hipfort_hipblas::hipblassnrm2::hipblassnrm2_rank_1	(	type(c_ptr)	handle,
		integer(c_int)	n,
		real(c_float), dimension(:), target	x,
		integer(c_int)	incx,
		type(c_ptr)	myresult
	)

---

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

• hipfort_hipblas.F90