Developer Guide

  • 2021.1
  • 12/04/2020
  • Public Content
Contents

Notational Conventions

The following term is used in reference to the operating system.
Linux*
This term refers to information that is valid on all supported
Linux*
operating systems.
The following notations are used to refer to
Intel® oneAPI Math Kernel Library
directories.
<parent directory>
The installation directory that includes
Intel® oneAPI Math Kernel Library
directory; for example, the directory for Intel® Parallel Studio XE Composer Edition.
<mkl directory>
The main directory where
Intel® oneAPI Math Kernel Library
is installed:
<mkl directory>
=
<parent directory>
/
mkl
.
Replace this placeholder with the specific pathname in the configuring, linking, and building instructions.
The following font conventions are used in this document.
Italic
Italic is used for emphasis and also indicates document names in body text, for example:
see
Intel® oneAPI Math Kernel Library
Developer Reference
.
Monospace lowercase
Indicates filenames, directory names, and pathnames, for example:
./benchmarks/linpack
Monospace lowercase mixed with uppercase
Indicates:
  • Commands and command-line options, for example,
    icc myprog.c -L$MKLPATH -I$MKLINCLUDE -lmkl -liomp5 -lpthread  
  • Filenames, directory names, and pathnames, for example,
  • C/C++ code fragments, for example,
    a = new double [SIZE*SIZE];
UPPERCASE MONOSPACE
Indicates system variables, for example,
$MKLPATH.
Monospace italic
Indicates a parameter in discussions, for example,
lda
.
When enclosed in angle brackets, indicates a placeholder for an identifier, an expression, a string, a symbol, or a value, for example,
<mkl directory>
. Substitute one of these items for the placeholder.
[ items ]
Square brackets indicate that the items enclosed in brackets are optional.
{ item | item }
Braces indicate that only one of the items listed between braces should be selected. A vertical bar ( | ) separates the items.

Product and Performance Information

1

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