The code and syntax used in this manual for function and variable declarations are written in the ANSI C style. However, versions of Intel IPP for different processors or operating systems may, of necessity, vary slightly.
This manual uses the following notational conventions:
- Fonts used for distinction between the text and the code;
- Signal name conventions;
- Naming conventions for different items.
Font Conventions
The following font conventions are used:
THIS TYPE STYLE |
Used in the text for the Intel IPP constant identifiers. For example, IPPI_MAX_64S. |
This type style |
Mixed with the uppercase in structure names as in IppLibraryVersion; also used in function names, code examples and call statements; for example, void ippsFree(). |
This type style |
Parameters in function prototypes and parameters description; for example:value, srcStep. |
Signal Name Conventions
In this manual, vectors and arrays are commonly used to represent a discrete 1D signal. The notation x(n) refers to a conceptual signal, while the notation x[n] refers to an actual vector. Both of these are annotated to indicate a specific finite range of values:
x[n], 0 ≤ n< len.
Typically, the number of elements in vectors is denoted by len. Vector names contain square brackets as distinct from vector elements with current index n.
For example, the expression pDst[n] = pSrc[n] + val implies that each element pDst[n] of the vector pDst is computed for each n in the range from 0 to len-1. Special cases are regarded and described separately.
Naming Conventions
The following naming conventions for different items are used by the Intel IPP software:
- Constant identifiers are in uppercase; for example, IPP_MIN_64S.
- All structures and enumerators, specific for the signal processing domain have the Ipps prefix, while those common for entire Intel IPP software have the Ipp prefix; for example, IppsROI, IppLibraryVersion.
- All names of the functions used for signal processing have the
ipps
prefix.
In code examples, you can distinguish the Intel IPP interface functions
from the application functions by this prefix.
NoteIn this manual, each function is introduced by its short name (without the ipps prefix and modifiers) and a brief description of its purpose.
The ipps prefix in function names is always used in the code examples. In the text, this prefix is usually omitted when referring to the function group.
- Each new part of a function name starts with an uppercase character, without underscore; for example, ippsAddAllRowSum.
For the detailed description of function name structure in Intel IPP, see Function Naming.