Developer Reference for Intel® oneAPI Math Kernel Library - C

Developer Reference

  • 0.9
  • 09/09/2020
  • Public Content
Contents

Notational Conventions

This manual uses the following terms to refer to operating systems:
Windows* OS
This term refers to information that is valid on all supported Windows* operating systems.
Linux* OS
This term refers to information that is valid on all supported Linux* operating systems.
macOS*
This term refers to information that is valid on Intel®-based systems running the macOS* operating system.
This manual uses the following notational conventions:
  • Routine name shorthand (for example,
    ?ungqr
     instead of
    cungqr
    /
    zungqr
    ).
  • Font conventions used for distinction between the text and the code.

Routine Name Shorthand

For shorthand, names that contain a question mark "
?
" represent groups of routines with similar functionality. Each group typically consists of routines used with four basic data types: single-precision real, double-precision real, single-precision complex, and double-precision complex. The question mark is used to indicate any or all possible varieties of a function; for example:
?swap
Refers to all four data types of the vector-vector
?swap
 routine:
sswap
,
dswap
,
cswap
, and
zswap
.

Font Conventions

The following font conventions are used:
lowercase courier
Code examples:
a[k+i][j] = matrix[i][j];
data types; for example,
const float*
lowercase courier mixed with UpperCase courier
Function names; for example,
vmlSetMode
lowercase courier italic
Variables in arguments and parameters description. For example,
incx
.
*
Used as a multiplication symbol in code examples and equations and where required by the programming language syntax.

Product and Performance Information

1

Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804