Developer Reference for Intel® oneAPI Math Kernel Library for C

ID 766684
Date 12/16/2022
Public

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

Document Table of Contents

vslGetStreamStateBrng

Returns index of a basic generator used for generation of a given random stream.

Syntax

brng = vslGetStreamStateBrng( stream );

Include Files
  • mkl.h
Input Parameters

Name

Type

Description

stream

const VSLStreamStatePtr

Pointer to the stream state structure

Output Parameters

Name

Type

Description

brng

int

Index of the basic generator assigned for the generation of stream ; negative in case of an error

Description

The vslGetStreamStateBrng function retrieves the index of a basic generator used for generation of a given random stream.

Return Values
VSL_ERROR_NULL_PTR

stream is a NULL pointer.

VSL_RNG_ERROR_BAD_STREAM

stream is not a valid random stream.