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

v?TGamma

Computes the gamma function of vector elements.

Syntax

vsTGamma( n, a, y );

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

vmsTGamma( n, a, y, mode );

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

vdTGamma( n, a, y );

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

vmdTGamma( n, a, y, mode );

vmdTGammaI(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 vsTGamma, vmsTGamma

const double* for vdTGamma, vmdTGamma

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 vsTGamma, vmsTGamma

double* for vdTGamma, vmdTGamma

Pointer to an array that contains the output vector y.

Description

The v?TGamma function computes the gamma function for elements of the input vector a and writes them to the output vector y. Precision overflow thresholds for the v?TGamma function are beyond the scope of this document. If the result does not meet the target precision, the function raises the OVERFLOW exception and sets the VM Error Status to VML_STATUS_OVERFLOW.

Special Values for Real Function v?TGamma(x)
Argument Result VM Error Status Exception
+0 + VML_STATUS_SING ZERODIVIDE
-0 - VML_STATUS_SING ZERODIVIDE
negative integer QNAN VML_STATUS_ERRDOM INVALID
- QNAN VML_STATUS_ERRDOM INVALID
+ +    
X > overflow + VML_STATUS_OVERFLOW OVERFLOW
QNAN QNAN    
SNAN QNAN   INVALID