glib/grand.h

   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, write to the
  16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
  17  * Boston, MA 02111-1307, USA.
  18  */
  19
  20 /*
  21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
  22  * file for a list of people on the GLib Team.  See the ChangeLog
  23  * files for a list of changes.  These files are distributed with
  24  * GLib at ftp://ftp.gtk.org/pub/gtk/.
  25  */
  26
  27 #ifndef __G_RAND_H__
  28 #define __G_RAND_H__
  29
  30 #include <glib/gtypes.h>
  31
  32 G_BEGIN_DECLS
  33
  34 typedef struct _GRand           GRand;
  35
  36 /* GRand - a good and fast random number generator: Mersenne Twister
  37  * see http://www.math.keio.ac.jp/~matumoto/emt.html for more info.
  38  * The range functions return a value in the intervall [begin, end).
  39  * int          -> [0..2^32-1]
  40  * int_range    -> [begin..end-1]
  41  * double       -> [0..1)
  42  * double_range -> [begin..end)
  43  */
  44
  45 GRand*  g_rand_new_with_seed  (guint32  seed);
  46 GRand*  g_rand_new_with_seed_array (const guint32 *seed,
  47                                     guint seed_length);
  48 GRand*  g_rand_new            (void);
  49 void    g_rand_free           (GRand   *rand_);
  50 GRand*  g_rand_copy           (GRand   *rand_);
  51 void    g_rand_set_seed       (GRand   *rand_,
  52                                guint32  seed);
  53 void    g_rand_set_seed_array (GRand   *rand_,
  54                                const guint32 *seed,
  55                                guint    seed_length);
  56
  57 #define g_rand_boolean(rand_) ((g_rand_int (rand_) & (1 << 15)) != 0)
  58
  59 guint32 g_rand_int            (GRand   *rand_);
  60 gint32  g_rand_int_range      (GRand   *rand_,
  61                                gint32   begin,
  62                                gint32   end);
  63 gdouble g_rand_double         (GRand   *rand_);
  64 gdouble g_rand_double_range   (GRand   *rand_,
  65                                gdouble  begin,
  66                                gdouble  end);
  67 void    g_random_set_seed     (guint32  seed);
  68
  69 #define g_random_boolean() ((g_random_int () & (1 << 15)) != 0)
  70
  71 guint32 g_random_int          (void);
  72 gint32  g_random_int_range    (gint32   begin,
  73                                gint32   end);
  74 gdouble g_random_double       (void);
  75 gdouble g_random_double_range (gdouble  begin,
  76                                gdouble  end);
  77
  78
  79 G_END_DECLS
  80
  81 #endif /* __G_RAND_H__ */
  82
  83
  84
  85
  86
  87