Merge branch 'blender2.7'
[blender.git] / source / blender / blenlib / BLI_rand.h
1 /*
2  * This program is free software; you can redistribute it and/or
3  * modify it under the terms of the GNU General Public License
4  * as published by the Free Software Foundation; either version 2
5  * of the License, or (at your option) any later version.
6  *
7  * This program is distributed in the hope that it will be useful,
8  * but WITHOUT ANY WARRANTY; without even the implied warranty of
9  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  * GNU General Public License for more details.
11  *
12  * You should have received a copy of the GNU General Public License
13  * along with this program; if not, write to the Free Software Foundation,
14  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
15  *
16  * The Original Code is Copyright (C) 2001-2002 by NaN Holding BV.
17  * All rights reserved.
18  */
19
20 #ifndef __BLI_RAND_H__
21 #define __BLI_RAND_H__
22
23 /** \file \ingroup bli
24  *  \brief Random number functions.
25  */
26
27 /* RNG is an abstract random number generator type that avoids using globals.
28  * Always use this instead of the global RNG unless you have a good reason,
29  * the global RNG is not thread safe and will not give repeatable results.
30  */
31 struct RNG;
32 typedef struct RNG RNG;
33
34 struct RNG_THREAD_ARRAY;
35 typedef struct RNG_THREAD_ARRAY RNG_THREAD_ARRAY;
36
37 struct RNG *BLI_rng_new(unsigned int seed);
38 struct RNG *BLI_rng_new_srandom(unsigned int seed);
39 void        BLI_rng_free(struct RNG *rng) ATTR_NONNULL(1);
40
41 void        BLI_rng_seed(struct RNG *rng, unsigned int seed) ATTR_NONNULL(1);
42 void        BLI_rng_srandom(struct RNG *rng, unsigned int seed) ATTR_NONNULL(1);
43 void        BLI_rng_get_char_n(RNG *rng, char *bytes, size_t bytes_len) ATTR_NONNULL(1, 2);
44 int         BLI_rng_get_int(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
45 unsigned int BLI_rng_get_uint(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
46 double      BLI_rng_get_double(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
47 float       BLI_rng_get_float(struct RNG *rng) ATTR_WARN_UNUSED_RESULT ATTR_NONNULL(1);
48 void        BLI_rng_get_float_unit_v2(struct RNG *rng, float v[2]) ATTR_NONNULL(1, 2);
49 void        BLI_rng_get_float_unit_v3(struct RNG *rng, float v[3]) ATTR_NONNULL(1, 2);
50 void        BLI_rng_get_tri_sample_float_v2(
51         struct RNG *rng, const float v1[2], const float v2[2], const float v3[2],
52         float r_pt[2]) ATTR_NONNULL();
53 void        BLI_rng_shuffle_array(struct RNG *rng, void *data, unsigned int elem_size_i, unsigned int elem_tot) ATTR_NONNULL(1, 2);
54
55 /** Note that skipping is as slow as generating n numbers! */
56 void        BLI_rng_skip(struct RNG *rng, int n) ATTR_NONNULL(1);
57
58 /* fill an array with random numbers */
59 void    BLI_array_frand(float *ar, int count, unsigned int seed);
60
61 /** Return a pseudo-random (hash) float from an integer value */
62 float   BLI_hash_frand(unsigned int seed) ATTR_WARN_UNUSED_RESULT;
63
64 /** Shuffle an array randomly using the given seed.
65  * contents. This routine does not use nor modify
66  * the state of the BLI random number generator.
67  */
68 void    BLI_array_randomize(void *data, unsigned int elem_size, unsigned int elem_tot, unsigned int seed);
69
70
71 /** Better seed for the random number generator, using noise.c hash[] */
72 /** Allows up to BLENDER_MAX_THREADS threads to address */
73 void    BLI_thread_srandom(int thread, unsigned int seed);
74
75 /** Return a pseudo-random number N where 0<=N<(2^31) */
76 /** Allows up to BLENDER_MAX_THREADS threads to address */
77 int     BLI_thread_rand(int thread) ATTR_WARN_UNUSED_RESULT;
78
79 /** Return a pseudo-random number N where 0.0f<=N<1.0f */
80 /** Allows up to BLENDER_MAX_THREADS threads to address */
81 float   BLI_thread_frand(int thread) ATTR_WARN_UNUSED_RESULT;
82
83 /** array versions for thread safe random generation */
84 RNG_THREAD_ARRAY *BLI_rng_threaded_new(void);
85 void  BLI_rng_threaded_free(struct RNG_THREAD_ARRAY *rngarr) ATTR_NONNULL(1);
86 int   BLI_rng_thread_rand(RNG_THREAD_ARRAY *rngarr, int thread) ATTR_WARN_UNUSED_RESULT;
87
88 /** Low-discrepancy sequences **/
89
90 /** Return the _n_th number of the given low-discrepancy sequence. */
91 void BLI_halton_1D(unsigned int prime, double offset, int n, double *r);
92 void BLI_halton_2D(unsigned int prime[2], double offset[2], int n, double *r);
93 void BLI_halton_3D(unsigned int prime[3], double offset[3], int n, double *r);
94 void BLI_hammersley_1D(unsigned int n, double *r);
95
96 /** Return the whole low-discrepancy sequence up to _n_. */
97 void BLI_halton_2D_sequence(unsigned int prime[2], double offset[2], int n, double *r);
98 void BLI_hammersley_2D_sequence(unsigned int n, double *r);
99
100 #endif  /* __BLI_RAND_H__ */