Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/22/2024
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

cblas_i?amin

Finds the index of the element with the smallest absolute value.

Syntax

CBLAS_INDEX cblas_isamin (const MKL_INT n, const float *x, const MKL_INT incx);

CBLAS_INDEX cblas_idamin (const MKL_INT n, const double *x, const MKL_INT incx);

CBLAS_INDEX cblas_icamin (const MKL_INT n, const void *x, const MKL_INT incx);

CBLAS_INDEX cblas_izamin (const MKL_INT n, const void *x, const MKL_INT incx);

Include Files

  • mkl.h

Description

Given a vector x, the i?amin functions return the position of the vector element x[i] that has the smallest absolute value for real flavors, or the smallest sum |Re(x[i])|+|Im(x[i])| for complex flavors.

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

n

On entry, n specifies the number of elements in vector x.

x

Array, size at least (1+(n-1)*abs(incx)).

incx

Specifies the increment for the elements of x.

Return Values

Indicates the position of vector element with the smallest absolute value such that x[index-1] has the smallest absolute value. The index returned is zero-based.