Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 3/31/2023
Public

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

Document Table of Contents

v?Cos

Computes cosine of vector elements.

Syntax

vsCos( n, a, y );

vsCosI(n, a, inca, y, incy);

vmsCos( n, a, y, mode );

vmsCosI(n, a, inca, y, incy, mode);

vdCos( n, a, y );

vdCosI(n, a, inca, y, incy);

vmdCos( n, a, y, mode );

vmdCosI(n, a, inca, y, incy, mode);

vcCos( n, a, y );

vcCosI(n, a, inca, y, incy);

vmcCos( n, a, y, mode );

vmcCosI(n, a, inca, y, incy, mode);

vzCos( n, a, y );

vzCosI(n, a, inca, y, incy);

vmzCos( n, a, y, mode );

vmzCosI(n, a, inca, y, incy, mode);

Include Files
  • mkl.h
Input Parameters

Name

Type

Description

n

const MKL_INT

Specifies the number of elements to be calculated.

a

const float* for vsCos, vmsCos

const double* for vdCos, vmdCos

const MKL_Complex8* for vcCos, vmcCos

const MKL_Complex16* for vzCos, vmzCos

Pointer to an array that contains the input vector a.

inca, incy

const MKL_INT

Specifies increments for the elements of a and y.

mode

const MKL_INT64

Overrides global VM mode setting for this function call. See vmlSetMode for possible values and their description.

Output Parameters

Name

Type

Description

y

float* for vsCos, vmsCos

double* for vdCos, vmdCos

MKL_Complex8* for vcCos, vmcCos

MKL_Complex16* for vzCos, vmzCos

Pointer to an array that contains the output vector y.

Description

The v?Cos function computes cosine of vector elements.

Note that arguments abs(a[i]) ≤ 213 and abs(a[i]) ≤ 216 for single and double precisions respectively are called fast computational path. These are trigonometric function arguments for which VM provides the best possible performance. Avoid arguments that do not belong to the fast computational path in the VM High Accuracy (HA) and Low Accuracy (LA) functions. Alternatively, you can use VM Enhanced Performance (EP) functions that are fast on the entire function domain. However, these functions provide less accuracy.

Special Values for Real Function v?Cos(x)
Argument Result VM Error Status Exception
+0 +1    
-0 +1    
+ QNAN VML_STATUS_ERRDOM INVALID
- QNAN VML_STATUS_ERRDOM INVALID
QNAN QNAN    
SNAN QNAN   INVALID

Specifications for special values of the complex functions are defined according to the following formula

Cos(z) = Cosh(i*z).

Product and Performance Information

Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.

Notice revision #20201201