A newer version of this document is available. Customers should click here to go to the newest version.
Visible to Intel only — GUID: GUID-2632E199-EFBC-4D35-8143-4789CB104733
Visible to Intel only — GUID: GUID-2632E199-EFBC-4D35-8143-4789CB104733
iamin
Finds the index of the element with the smallest absolute value in a vector
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 minimal (complex variants).
iamin supports the following precisions:
T |
|---|
float |
double |
std::complex<float> |
std::complex<double> |
If either n or incx is not positive, the routine returns 0, regardless of the base of the index selected.
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.
iamin (Buffer Version)
Syntax
namespace oneapi::mkl::blas::column_major {
void iamin(sycl::queue &queue,
std::int64_t n,
sycl::buffer<T,1> &x,
std::int64_t incx,
sycl::buffer<std::int64_t,1> &result,
index_base base = index_base::zero)
}
namespace oneapi::mkl::blas::row_major {
void iamin(sycl::queue &queue,
std::int64_t n,
sycl::buffer<T,1> &x,
std::int64_t incx,
sycl::buffer<std::int64_t,1> &result,
index_base base = index_base::zero)
}
Input Parameters
- queue
-
The queue where the routine will be executed.
- n
-
Number of elements in vector x.
- x
-
Buffer holding input vector x. Size of the buffer must be at least (1 + (n - 1)*abs(incx)). See Matrix Storage for more details.
- incx
-
Stride of vector x.
- base
-
Indicates how the output value is indexed. If omitted, defaults to zero-based indexing.
oneapi::mkl::index_base::zero
Zero-based (C-style) indexing: indices start at 0.
oneapi::mkl::index_base::one
One-based (Fortran-style) indexing: indices start at 1.
Output Parameters
- result
-
Buffer where the index i of the minimum element is stored.
iamin (USM Version)
Syntax
namespace oneapi::mkl::blas::column_major {
sycl::event iamin(sycl::queue &queue,
std::int64_t n,
const T *x,
std::int64_t incx,
std::int64_t *result,
index_base base = index_base::zero,
const std::vector<sycl::event> &dependencies = {})
}
namespace oneapi::mkl::blas::row_major {
sycl::event iamin(sycl::queue &queue,
std::int64_t n,
const T *x,
std::int64_t incx,
std::int64_t *result,
index_base base = index_base::zero,
const std::vector<sycl::event> &dependencies = {})
}
Input Parameters
- queue
-
The queue where the routine will be executed.
- n
-
Number of elements in vector x.
- x
-
The pointer to input vector x. Size of the array holding input vector x must be at least (1 + (n - 1)*abs(incx)). See Matrix Storage for more details.
- incx
-
Stride of vector x.
- base
-
Indicates how the output value is indexed. If omitted, defaults to zero-based indexing.
oneapi::mkl::index_base::zero
Zero-based (C-style) indexing: indices start at 0.
oneapi::mkl::index_base::one
One-based (Fortran-style) indexing: indices start at 1.
- dependencies
-
List of events to wait for before starting computation, if any. If omitted, defaults to no dependencies.
Output Parameters
- result
-
Pointer to where the index i of the minimum element is stored.
Return Values
Output event to wait on to ensure computation is complete.