Intel® Integrated Performance Primitives Developer Guide and Reference

ID 790148
Date 11/07/2023
Public

A newer version of this document is available. Customers should click here to go to the newest version.

Document Table of Contents

SetNumThreads

Sets the number of threads in the multithreading environment.

Syntax

Case 1: Setting number of threads for operations on objects of 32-bit size

IppStatus ippSetNumThreads(int numThr);

Case 2: Setting number of threads for operations with TL functions based on the Platform Aware API

IppStatus ippSetNumThreads_LT(int numThr);

Case 3: Setting number of threads for operations with TL functions based on the Classic API

IppStatus ippSetNumThreads_T(int numThr);

Include Files

ippcore.h

Parameters

numThr

Number of threads, should be more than zero.

Description

This function sets the number of OpenMP* threads. A number of established threads may be less than specified numThr. Functions are not thread-safe and shall be called outside of the parallel region of the program.

Return Values

ippStsNoErr

Indicates no error.

ippStsSizeErr

Indicates an error when numThr is less than, or equal to zero.

ippStsNoOperation

Indicates that the function is called from the application linked to the single-threaded version of the library. No operation is performed.

ippStsOperationNotSupported

Indicates that function trying to set the number of TBB threads.