svn merge -r40140:r40148 https://svn.blender.org/svnroot/bf-blender/trunk/blender
[blender.git] / source / blender / blenlib / BLI_rand.h
1 /*
2  * $Id$
3  *
4  * ***** BEGIN GPL LICENSE BLOCK *****
5  *
6  * This program is free software; you can redistribute it and/or
7  * modify it under the terms of the GNU General Public License
8  * as published by the Free Software Foundation; either version 2
9  * of the License, or (at your option) any later version.
10  *
11  * This program 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
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software Foundation,
18  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
19  *
20  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
21  * All rights reserved.
22  *
23  * The Original Code is: all of this file.
24  *
25  * Contributor(s): none yet.
26  *
27  * ***** END GPL LICENSE BLOCK *****
28  */
29  
30 #ifndef BLI_RAND_H
31 #define BLI_RAND_H
32
33 /** \file BLI_rand.h
34  *  \ingroup bli
35  *  \brief Random number functions.
36  */
37
38 /** RNG is just an abstract random number generator
39  * type that avoids using globals, otherwise identical
40  * to BLI_rand functions below.
41  */
42 struct RNG;
43 typedef struct RNG RNG;
44
45 struct RNG*     rng_new                 (unsigned int seed);
46 void            rng_free                (struct RNG* rng);
47
48 void            rng_seed                (struct RNG* rng, unsigned int seed);
49 void rng_srandom(struct RNG *rng, unsigned int seed);
50 int                     rng_getInt              (struct RNG* rng);
51 double          rng_getDouble   (struct RNG* rng);
52 float           rng_getFloat    (struct RNG* rng);
53 void            rng_shuffleArray(struct RNG *rng, void *data, int elemSize, int numElems);
54
55         /** Note that skipping is as slow as generating n numbers! */
56 void            rng_skip                (struct RNG *rng, int n);
57
58         /** Seed the random number generator */
59 void    BLI_srand               (unsigned int seed);
60
61         /** Better seed for the random number generator, using noise.c hash[] */
62 void    BLI_srandom             (unsigned int seed);
63
64         /** Return a pseudo-random number N where 0<=N<(2^31) */
65 int             BLI_rand                (void);
66
67         /** Return a pseudo-random number N where 0.0<=N<1.0 */
68 double  BLI_drand               (void);
69
70         /** Return a pseudo-random number N where 0.0f<=N<1.0f */
71 float   BLI_frand               (void);
72
73         /** Fills a block of memory starting at @a addr
74          * and extending @a len bytes with pseudo-random
75          * contents. This routine does not use nor modify
76          * the state of the BLI random number generator.
77          */
78 void    BLI_fillrand    (void *addr, int len);
79
80         /** Shuffle an array randomly using the given seed.
81          * contents. This routine does not use nor modify
82          * the state of the BLI random number generator.
83          */
84 void    BLI_array_randomize     (void *data, int elemSize, int numElems, unsigned int seed);
85
86
87         /** Better seed for the random number generator, using noise.c hash[] */
88         /** Allows up to BLENDER_MAX_THREADS threads to address */
89 void    BLI_thread_srandom      (int thread, unsigned int seed);
90
91         /** Return a pseudo-random number N where 0<=N<(2^31) */
92         /** Allows up to BLENDER_MAX_THREADS threads to address */
93 int             BLI_thread_rand         (int thread);
94
95         /** Return a pseudo-random number N where 0.0f<=N<1.0f */
96         /** Allows up to BLENDER_MAX_THREADS threads to address */
97 float   BLI_thread_frand        (int thread);
98
99
100
101 #endif
102