Intel® C++ Compiler Classic Developer Guide and Reference

ID 767249
Date 3/31/2023
Public

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

Document Table of Contents

svrng_new_mt19937_engine/svrng_new_mt19937_ex

Routines for allocating memory for an mt19937 engine and initializing with one or multiple seeds

Syntax

svrng_engine_t svrng_new_mt19937_engine( uint32_t seed )

svrng_engine_t svrng_new_mt19937_engine_ex( int num, uint32_t *pseed )

Input Parameters

seed

Initial condition for the engine.

num

Number of initialization values for the extended routine. num>=0. See VSL Notes for further details on extended initialization of the mt19937 engine.

pseed

Pointer to an array with initialization values for the extended routine.

Description

The svrng_new_mt19937_engine function allocates memory for the mt19937 engine (from C++ 11 standard) and initializes it using one seed value. The extended version of the function, svrng_new_mt19937_engine_ex, accepts several values for complex initialization cases. Because the mt19937 engine has 19937 bits of state in memory, its initialization differs from the other engines. See the Notes for Intel® oneAPI Math Kernel Library Vector Statistics document for detailed information on this engine.

Status flags set

Name

Description

SVRNG_STATUS_ERROR_MEMORY_ALLOC

Memory allocation failure

SVRNG_STATUS_ERROR_BAD_PARAM1

Bad parameter: num

SVRNG_STATUS_ERROR_BAD_PARAM2

Bad parameter: pseed

Return Values

A pointer to an initialized engine or NULL on error.

Application Notes

The mt19937 is a Mersenne Twister pseudo-random generator of 32-bit numbers with a state size of 19937 bits that is a modification of twisted generalized feedback shift register generator. Range: [0,MAX), where MAX = 232.

See Also