Developer Reference

  • 2021
  • 03/26/2021
  • Public Content
Contents

Notational Conventions

The code and syntax used in this document 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.
Product and Performance Information
Performance varies by use, configuration and other factors. Learn more at www.Intel.com/PerformanceIndex.
Notice revision #20201201
This document uses the following notational conventions:
Convention
Explanation
Example
THIS TYPE STYLE
Used in the text for the Intel IPP constant identifiers.
IPPI_MAX_64S
This type style
Mixed with the uppercase in structure names; also used in function names, code examples and call statements.
IppLibraryVersion
,
void ippsFree()
This type style
Parameters in function prototypes and parameters description.
value
,
srcStep
x(n)
and
x
[
n
]
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
.
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.
Ipp<
data-domain
>
and
Ipp
prefixes
All structures and enumerators, specific for a particular data-domain have the
Ipp<
data-domain
>
prefix, while those common for entire Intel IPP software have the
Ipp
prefix.
IppsROI
,
IppLibraryVersion

Product and Performance Information

1

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