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