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.
Optimization Notice |
|---|
|
The Intel® Integrated Performance Primitives (Intel® IPP) library contains functions that are more highly optimized for Intel microprocessors than for other microprocessors. While the functions in the Intel® IPP library offer optimizations for both Intel and Intel-compatible microprocessors, depending on your code and other factors, you will likely get extra performance on Intel microprocessors. While the paragraph above describes the basic optimization approach for the Intel® IPP library as a whole, the library may or may not be optimized to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include Intel® Streaming SIMD Extensions 2 (Intel® SSE2), Intel® Streaming SIMD Extensions 3 (Intel® SSE3), and Supplemental Streaming SIMD Extensions 3 (Intel® 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. Intel recommends that you evaluate other library products to determine which best meets your requirements. |
This manual uses the following notational conventions:
Font conventions used for distinction between the text and the code.
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_INTER_LINEAR. |
This type style |
Mixed with the uppercase in structure names as in IppiSize; also used in function names, code examples and call statements; for example, ippiMomentInitAlloc(). |
This type style |
Parameters in function prototypes and parameters description; for example:value, srcStep. |
Naming Conventions
The following naming conventions for different items are used by the Intel IPP software:
Constant identifiers are in uppercase; for example, IPPI_INTER_CUBIC
All structures and enumerators, specific for the image and video processing domain have the Ippi prefix, while those common for entire Intel IPP software have the Ipp prefix; for example, IppiPoint, IppDitherType.
All names of the functions used for image and video processing have the ippi prefix. In code examples, you can distinguish the Intel IPP interface functions from the application functions by this prefix.
NoteEach function is introduced by its short name (without the ippi prefix and descriptors) and a brief description of its purpose.
The ippi prefix is also omitted when referring to the function group names, for example, in the summary tables. Function prototypes and references in the text contain full names.
Each new part of a function name starts with an uppercase character, without underscore; for example, ippiGetSpatialMoment.
For the detailed description of function name structure in Intel IPP, see Function Naming in Intel® Integrated Performance Primitives Concepts.