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