iamin (USM Version)¶
Finds the index of the element with the smallest absolute value.
Syntax
-
event
iamin
(queue &exec_queue, std::int64_t n, const T *x, std::int64_t incx, T_res *result, const vector_class<event> &dependencies = {})¶
The USM version of iamin
supports the following precisions and
devices.
T |
Devices Supported |
---|---|
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
|
Host, CPU, and GPU |
Description
The iamin routines return an index i
such that x
[i
] has
the minimum absolute value of all elements in vector x
(real
variants), or such that |Re(x
[i
])| +
|Im(x
[i
])| is maximal (complex variants).
Note
The index is zero-based.
If either n
or incx
are not positive, the routine returns
0
.
If more than one vector element is found with the same smallest absolute value, the index of the first one encountered is returned.
If the vector contains NaN
values, then the routine returns the
index of the first NaN
.
Input Parameters
- exec_queue
The queue where the routine should be executed.
- n
Number of elements in vector
x
.- x
The pointer to input vector
x
. The array holding input vectorx
must be of size at least (1 + (n
- 1)*abs(incx
)). See Matrix and Vector Storage for more details.- incx
Stride of vector x.
Output Parameters
- result
Pointer to where the zero-based index
i
of the minimum element will be stored.
Return Values
Output event to wait on to ensure computation is complete.