File: Random-number-generator-initialization.html

package info (click to toggle)
gsl-ref-html 1.10-1
  • links: PTS
  • area: main
  • in suites: lenny
  • size: 4,496 kB
  • ctags: 2,955
  • sloc: makefile: 33
file content (94 lines) | stat: -rw-r--r-- 5,045 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
<html lang="en">
<head>
<title>Random number generator initialization - GNU Scientific Library -- Reference Manual</title>
<meta http-equiv="Content-Type" content="text/html">
<meta name="description" content="GNU Scientific Library -- Reference Manual">
<meta name="generator" content="makeinfo 4.8">
<link title="Top" rel="start" href="index.html#Top">
<link rel="up" href="Random-Number-Generation.html" title="Random Number Generation">
<link rel="prev" href="The-Random-Number-Generator-Interface.html" title="The Random Number Generator Interface">
<link rel="next" href="Sampling-from-a-random-number-generator.html" title="Sampling from a random number generator">
<link href="http://www.gnu.org/software/texinfo/" rel="generator-home" title="Texinfo Homepage">
<!--
Copyright (C) 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007 The GSL Team.

Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.2 or
any later version published by the Free Software Foundation; with the
Invariant Sections being ``GNU General Public License'' and ``Free Software
Needs Free Documentation'', the Front-Cover text being ``A GNU Manual'',
and with the Back-Cover Text being (a) (see below).  A copy of the
license is included in the section entitled ``GNU Free Documentation
License''.

(a) The Back-Cover Text is: ``You have freedom to copy and modify this
GNU Manual, like GNU software.''-->
<meta http-equiv="Content-Style-Type" content="text/css">
<style type="text/css"><!--
  pre.display { font-family:inherit }
  pre.format  { font-family:inherit }
  pre.smalldisplay { font-family:inherit; font-size:smaller }
  pre.smallformat  { font-family:inherit; font-size:smaller }
  pre.smallexample { font-size:smaller }
  pre.smalllisp    { font-size:smaller }
  span.sc    { font-variant:small-caps }
  span.roman { font-family:serif; font-weight:normal; } 
  span.sansserif { font-family:sans-serif; font-weight:normal; } 
--></style>
</head>
<body>
<div class="node">
<p>
<a name="Random-number-generator-initialization"></a>
Next:&nbsp;<a rel="next" accesskey="n" href="Sampling-from-a-random-number-generator.html">Sampling from a random number generator</a>,
Previous:&nbsp;<a rel="previous" accesskey="p" href="The-Random-Number-Generator-Interface.html">The Random Number Generator Interface</a>,
Up:&nbsp;<a rel="up" accesskey="u" href="Random-Number-Generation.html">Random Number Generation</a>
<hr>
</div>

<h3 class="section">17.3 Random number generator initialization</h3>

<div class="defun">
&mdash; Function: gsl_rng * <b>gsl_rng_alloc</b> (<var>const gsl_rng_type * T</var>)<var><a name="index-gsl_005frng_005falloc-1478"></a></var><br>
<blockquote><p>This function returns a pointer to a newly-created
instance of a random number generator of type <var>T</var>. 
For example, the following code creates an instance of the Tausworthe
generator,

     <pre class="example">          gsl_rng * r = gsl_rng_alloc (gsl_rng_taus);
</pre>
        <p>If there is insufficient memory to create the generator then the
function returns a null pointer and the error handler is invoked with an
error code of <code>GSL_ENOMEM</code>.

        <p>The generator is automatically initialized with the default seed,
<code>gsl_rng_default_seed</code>.  This is zero by default but can be changed
either directly or by using the environment variable <code>GSL_RNG_SEED</code>
(see <a href="Random-number-environment-variables.html">Random number environment variables</a>).

        <p>The details of the available generator types are
described later in this chapter. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: void <b>gsl_rng_set</b> (<var>const gsl_rng * r, unsigned long int s</var>)<var><a name="index-gsl_005frng_005fset-1479"></a></var><br>
<blockquote><p>This function initializes (or `seeds') the random number generator.  If
the generator is seeded with the same value of <var>s</var> on two different
runs, the same stream of random numbers will be generated by successive
calls to the routines below.  If different values of <var>s</var> are
supplied, then the generated streams of random numbers should be
completely different.  If the seed <var>s</var> is zero then the standard seed
from the original implementation is used instead.  For example, the
original Fortran source code for the <code>ranlux</code> generator used a seed
of 314159265, and so choosing <var>s</var> equal to zero reproduces this when
using <code>gsl_rng_ranlux</code>. 
</p></blockquote></div>

<div class="defun">
&mdash; Function: void <b>gsl_rng_free</b> (<var>gsl_rng * r</var>)<var><a name="index-gsl_005frng_005ffree-1480"></a></var><br>
<blockquote><p>This function frees all the memory associated with the generator
<var>r</var>. 
</p></blockquote></div>

<hr>The GNU Scientific Library - a free numerical library licensed under the GNU GPL<br>Back to the <a href="/software/gsl/">GNU Scientific Library Homepage</a></body></html>