Filling in branch from trunk
[blender.git] / source / blender / blenlib / BLI_rand.h
1 /**
2  * @file BLI_rand.h
3  * 
4  * Random number functions.
5  * $Id$
6  *
7  * ***** BEGIN GPL/BL DUAL LICENSE BLOCK *****
8  *
9  * This program is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU General Public License
11  * as published by the Free Software Foundation; either version 2
12  * of the License, or (at your option) any later version. The Blender
13  * Foundation also sells licenses for use in proprietary software under
14  * the Blender License.  See http://www.blender.org/BL/ for information
15  * about this.
16  *
17  * This program is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with this program; if not, write to the Free Software Foundation,
24  * Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
25  *
26  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
27  * All rights reserved.
28  *
29  * The Original Code is: all of this file.
30  *
31  * Contributor(s): none yet.
32  *
33  * ***** END GPL/BL DUAL LICENSE BLOCK *****
34  */
35  
36 #ifndef BLI_RAND_H
37 #define BLI_RAND_H
38
39         /* RNG is just an abstract random number generator
40          * type that avoids using globals, otherwise identical
41          * to BLI_rand functions below.
42          */
43 struct RNG;
44 typedef struct RNG RNG;
45
46 struct RNG*     rng_new                 (unsigned int seed);
47 void            rng_free                (struct RNG* rng);
48
49 void            rng_seed                (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         /** Seed the random number generator */
56 void    BLI_srand               (unsigned int seed);
57
58         /** Better seed for the random number generator, using noise.c hash[] */
59 void    BLI_srandom             (unsigned int seed);
60
61         /** Return a pseudo-random number N where 0<=N<(2^31) */
62 int             BLI_rand                (void);
63
64         /** Return a pseudo-random number N where 0.0<=N<1.0 */
65 double  BLI_drand               (void);
66
67         /** Return a pseudo-random number N where 0.0f<=N<1.0f */
68 float   BLI_frand               (void);
69
70         /** Fills a block of memory starting at @a addr
71          * and extending @a len bytes with pseudo-random
72          * contents. This routine does not use nor modify
73          * the state of the BLI random number generator.
74          */
75 void    BLI_fillrand    (void *addr, int len);
76
77         /** Shuffle an array randomly using the given seed.
78          * contents. This routine does not use nor modify
79          * the state of the BLI random number generator.
80          */
81 void    BLI_array_randomize     (void *data, int elemSize, int numElems, unsigned int seed);
82
83
84         /** Better seed for the random number generator, using noise.c hash[] */
85         /** Allows up to 16 threads to address */
86 void    BLI_thread_srandom      (int thread, unsigned int seed);
87
88         /** Return a pseudo-random number N where 0<=N<(2^31) */
89         /** Allows up to 16 threads to address */
90 int             BLI_thread_rand         (int thread);
91
92         /** Return a pseudo-random number N where 0.0f<=N<1.0f */
93         /** Allows up to 16 threads to address */
94 float   BLI_thread_frand        (int thread);
95
96
97
98 #endif
99