Support Functions

This chapter describes Intel^® IPP support functions that are used to:

retrieve information about the current Intel IPP software version
allocate and free memory that is needed for the operation of other Intel IPP functions
retrieve information about the processor and perform specific auxiliary operations
functions for internationalization.

The full list of these functions is given in the table below.

Intel IPP Support Functions
Function Base Name	Operation
Version Information Functions
GetLibVersion	Returns information about the active library version.
Memory Allocation Functions
Malloc	Allocates memory aligned to 32-byte boundary.
Free	Frees memory allocated by the functionippsMalloc .
Common Functions
ippGetStatusString	Translates a status code into a message.
ippGetCpuType	Returns a processor type. See Optimization Notice below*)
ippGetCpuClocks	Returns a current value of the time stamp counter (TSC) register.
ippGetCpuFreqMhz	Estimates the processor frequency.
ippGetCpuFeatures	Retrieves the processor features.
ippGetEnabledCpuFeatures	Returns the enabled processor features for the loaded library.
ippGetNumCoresOnDie	Returns the number of cores.
ippGetMaxCacheSizeB	Returns maximum size of the L2 and L3 caches of the processor.
ippSetFlushToZero	Enables or disables flush-to-zero mode.
ippSetDenormAreZeros	Enables or disables denormals-are-zero mode.
ippAlignPtr	Aligns a pointer to the specified number of bytes.
ippSetNumThreads	Sets the number of threads in the multithread environment.
ippGetNumThreads	Returns the number of existing threads in the multithread environment.
ippSetAffinity	Binds OpenMP threads to OS processors.
ippMalloc	Allocates memory aligned to 32-byte boundary.
ippFree	Frees memory allocated by the function ippMalloc.
Dispatcher Control Functions
ippStaticInit	Automatically selects the most appropriate static code.
ippInit	Automatically initializes the version of the library code most appropriate for the current processor type.
ippStaticInitCpu	THIS FUNCTION IS DEPRECATED. Use the function ippInitCpu instead.
ippInitCpu	Initializes the specified version of the library code.
ippEnableCpu	Allows dispatching the processor-specific library
Internationalization Functions
ippMessageCatalogOpenI18n	Opens an i18n message catalog.
ippMessageCatalogCloseI18n	Closes the opened i18n message catalog.
ippGetMessageStatusI18n	Returns the translation of the status message.
ippStatusToMessageIdI18n	Transforms an Intel IPP status code to the message ID for the i18n message catalog.

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.

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.