1/* GLIB - Library of useful routines for C programming
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
3 *
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16 */
17
18/*
19 * Modified by the GLib Team and others 1997-2000. See the AUTHORS
20 * file for a list of people on the GLib Team. See the ChangeLog
21 * files for a list of changes. These files are distributed with
22 * GLib at ftp://ftp.gtk.org/pub/gtk/.
23 */
24
25#ifndef __G_RAND_H__
26#define __G_RAND_H__
27
28#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
29#error "Only <glib.h> can be included directly."
30#endif
31
32#include <glib/gtypes.h>
33
34G_BEGIN_DECLS
35
36typedef struct _GRand GRand;
37
38/* GRand - a good and fast random number generator: Mersenne Twister
39 * see http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html for more info.
40 * The range functions return a value in the intervall [begin, end).
41 * int -> [0..2^32-1]
42 * int_range -> [begin..end-1]
43 * double -> [0..1)
44 * double_range -> [begin..end)
45 */
46
47GLIB_AVAILABLE_IN_ALL
48GRand* g_rand_new_with_seed (guint32 seed);
49GLIB_AVAILABLE_IN_ALL
50GRand* g_rand_new_with_seed_array (const guint32 *seed,
51 guint seed_length);
52GLIB_AVAILABLE_IN_ALL
53GRand* g_rand_new (void);
54GLIB_AVAILABLE_IN_ALL
55void g_rand_free (GRand *rand_);
56GLIB_AVAILABLE_IN_ALL
57GRand* g_rand_copy (GRand *rand_);
58GLIB_AVAILABLE_IN_ALL
59void g_rand_set_seed (GRand *rand_,
60 guint32 seed);
61GLIB_AVAILABLE_IN_ALL
62void g_rand_set_seed_array (GRand *rand_,
63 const guint32 *seed,
64 guint seed_length);
65
66#define g_rand_boolean(rand_) ((g_rand_int (rand_) & (1 << 15)) != 0)
67
68GLIB_AVAILABLE_IN_ALL
69guint32 g_rand_int (GRand *rand_);
70GLIB_AVAILABLE_IN_ALL
71gint32 g_rand_int_range (GRand *rand_,
72 gint32 begin,
73 gint32 end);
74GLIB_AVAILABLE_IN_ALL
75gdouble g_rand_double (GRand *rand_);
76GLIB_AVAILABLE_IN_ALL
77gdouble g_rand_double_range (GRand *rand_,
78 gdouble begin,
79 gdouble end);
80GLIB_AVAILABLE_IN_ALL
81void g_random_set_seed (guint32 seed);
82
83#define g_random_boolean() ((g_random_int () & (1 << 15)) != 0)
84
85GLIB_AVAILABLE_IN_ALL
86guint32 g_random_int (void);
87GLIB_AVAILABLE_IN_ALL
88gint32 g_random_int_range (gint32 begin,
89 gint32 end);
90GLIB_AVAILABLE_IN_ALL
91gdouble g_random_double (void);
92GLIB_AVAILABLE_IN_ALL
93gdouble g_random_double_range (gdouble begin,
94 gdouble end);
95
96
97G_END_DECLS
98
99#endif /* __G_RAND_H__ */
100