Rate This Document
Findability
Accuracy
Completeness
Readability

Function for Skipping Elements in a Random Number Stream

Skip elements in a random number stream.

Interface Definition

int vslSkipAheadStream(VSLStreamStatePtr stream, const SizeType nskip);

Parameters

Parameter

Type

Description

Input/Output

stream

Pointer of the VSLStreamStatePtr type

Pointer to the random number stream structure.

Input/Output

nskip

SizeType

Number of elements to skip. The value must be a non-negative integer.

Input

Dependencies

#include "krng.h"

Examples

#include <stdio.h>
#include <stdlib.h>
#include "krng.h"
int main()
{
   /* initialize stream with given BRNG type and seed */
    VSLStreamStatePtr stream;
    unsigned seed = 42;
    int errcode = vslNewStream(&stream, VSL_BRNG_MCG59, seed);
    if (errcode != VSL_STATUS_OK) {
        fprintf(stderr, "Failure in newstream\n");
        return 0;
    }

    int forward_skip = 10;
    if (vslSkipAheadStream(stream, forward_skip)) {
        fprintf(stderr, "Failure in SkipAhead, skip = %d\n", forward_skip);
        return 0;
    }

    /* deinitialize the stream */
    errcode = vslDeleteStream(&stream);
    if (errcode != VSL_STATUS_OK) {
        fprintf(stderr, "Failure in deleting stream\n");
        return 0;
    }
    return 0;
}