Detailed Description

Generates random numbers.

Author: Creighton, J. D. E. and Tibbits, M. M.

Synopsis

#include <lal/Random.h>

This header covers the routines for generating random numbers.

Modules
	Module Random.c
	Functions for generating random numbers.

Data Structures
struct	RandomParams
	This structure contains the parameters necessary for generating the current sequence of random numbers (based on the initial seed). More...

Files
file	RandomTest.c
	Tests the routines in Random.h.

Error Codes
#define	RANDOMH_ENULL 1
	Null pointer. More...

#define	RANDOMH_ENNUL 2
	Non-null pointer. More...

#define	RANDOMH_ESIZE 4
	Invalid size. More...

#define	RANDOMH_ELNTH 8
	Must have more than one data point. More...

#define	RANDOMH_ESEGZ 16
	Invalid number of segments. More...

#define	RANDOMH_ENUMZ 32
	Invalid number of points in segment. More...

#define	RANDOMH_EALOC 64
	Memory Allocation Error. More...

#define	RANDOMH_EINIT 128
	Params must be initialized with CreateParams first. More...

#define	RANDOMH_EZERO 256
	Output Vector length must be greater than zero. More...

#define	RANDOMH_ESEED 512
	Improper seed value. More...

Macro Definition Documentation

◆ RANDOMH_ENULL

#define RANDOMH_ENULL 1

Null pointer.

Definition at line 51 of file Random.h.

◆ RANDOMH_ENNUL

#define RANDOMH_ENNUL 2

Non-null pointer.

Definition at line 52 of file Random.h.

◆ RANDOMH_ESIZE

#define RANDOMH_ESIZE 4

Invalid size.

Definition at line 53 of file Random.h.

◆ RANDOMH_ELNTH

#define RANDOMH_ELNTH 8

Must have more than one data point.

Definition at line 54 of file Random.h.

◆ RANDOMH_ESEGZ

#define RANDOMH_ESEGZ 16

Invalid number of segments.

Definition at line 55 of file Random.h.

◆ RANDOMH_ENUMZ

#define RANDOMH_ENUMZ 32

Invalid number of points in segment.

Definition at line 56 of file Random.h.

◆ RANDOMH_EALOC

#define RANDOMH_EALOC 64

Memory Allocation Error.

Definition at line 57 of file Random.h.

◆ RANDOMH_EINIT

#define RANDOMH_EINIT 128

Params must be initialized with CreateParams first.

Definition at line 58 of file Random.h.

◆ RANDOMH_EZERO

#define RANDOMH_EZERO 256

Output Vector length must be greater than zero.

Definition at line 59 of file Random.h.

◆ RANDOMH_ESEED

#define RANDOMH_ESEED 512

Improper seed value.

Definition at line 60 of file Random.h.