S3L_free_rand_fib

Description

S3L_free_rand_fib frees the state table associated with a particular Lagged-Fibonacci random number Generator (LFG).

Syntax

The C and Fortran syntax for S3L_free_rand_fib are shown below.

C/C++ Syntax

Example 8-69

#include <s3l/s3l-c.h>
#include <s3l/s3l_errno-c.h>
int
S3L__rand_fib(setup_id)
    int                *setup_id

F77/F90 Syntax

Example 8-70

include `s3l/s3l-f.h'
include `s3l/s3l_errno-f.h'
subroutine
S3L_rand_fib(setup_id, ier)
    integer*4          setup_id
    integer*4          ier

Input

• setup_id - Integer index that has been initialized by a call to S3L_setup_rand_fib and is used to identify a particular LFG setup.

Output

This function uses the following argument for output:

• ier (Fortran only) - When called from a Fortran program, this function returns error status in ier.

Error Handling

On success, S3L_setup_rand_fib returns S3L_SUCCESS.

On error, the following error code may be returned:

• S3L_ERR_ARG_SETUP - The setup_id value does not correspond to a valid setup.

Examples

../examples/s3l/rand_fib/rand_fib.c
../examples/s3l/rand_fib-f/rand_fib.f

Related Functions

S3L_rand_fib(3)
S3L_setup_rand_fib(3)