User's Guide: Usage:SPRNG Heaer Files

SPRNG Header Files

sprng.h

C users must include the header file sprng.h in their program. We explain below the purpose of this header file.

The actual names of SPRNG functions differ from the user calls. This header file defines certain macros that make the calls to the correct functions, depending on the interface and other options a user desires. Additionally, this file also defines the parameters for the generators, and a macro called MAX_PACKED_LENGTH which gives the maximum number of bytes required to store the state of any SPRNG stream.

sprng_f.h

FORTRAN users must include the header file sprng_f.h in their program. If SPRNG calls are made in several subroutines, then this file should be included at the beginning of each subroutine as shown in the following example:

Example

We explain below the purpose of this header file.

The actual names of SPRNG functions differ from those given in the SPRNG interfaces. This header file defines certain macros that make the calls to the correct functions, depending on the interface and other options a user desires. Additionally, this file also defines the parameters for the generators, and a macro called MAX_PACKED_LENGTH which gives the maximum number of bytes required to store the state of any SPRNG stream.

Another macro called POINTER is defined, which gives the name of an integer type large enough to hold a C pointer. FORTRAN programmers can use this macro as if it were a FORTRAN data type in order to store the results of those SPRNG functions that return pointers. More details on this can be found in the note on Stream ID's.

FORTRAN programmers unfamiliar with preprocessing directives can also take a look at the note to FORTRAN users on preprocessor directives.