Merge pull request #3339 from jkohen/patch-1
[collectd.git] / src / daemon / utils_random.h
1 /**
2  * collectd - src/utils_random.h
3  * Copyright (C) 2013       Florian Forster
4  *
5  * Permission is hereby granted, free of charge, to any person obtaining a
6  * copy of this software and associated documentation files (the "Software"),
7  * to deal in the Software without restriction, including without limitation
8  * the rights to use, copy, modify, merge, publish, distribute, sublicense,
9  * and/or sell copies of the Software, and to permit persons to whom the
10  * Software is furnished to do so, subject to the following conditions:
11  *
12  * The above copyright notice and this permission notice shall be included in
13  * all copies or substantial portions of the Software.
14  *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20  * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21  * DEALINGS IN THE SOFTWARE.
22  *
23  * Authors:
24  *   Florian Forster <octo at collectd.org>
25  **/
26
27 #ifndef UTILS_RANDOM_H
28 #define UTILS_RANDOM_H 1
29
30 /**
31  * Returns a random double value in the range [0..1), i.e. excluding 1.
32  *
33  * This function is thread- and reentrant-safe.
34  */
35 double cdrand_d(void);
36
37 /**
38  * cdrand_u returns a random uint32_t value uniformly distributed in the range
39  * [0-2^32).
40  *
41  * This function is thread- and reentrant-safe.
42  */
43 uint32_t cdrand_u(void);
44
45 /**
46  * Returns a random long between min and max, inclusively.
47  *
48  * If min is larger than max, the result may be rounded incorrectly and may be
49  * outside the intended range. This function is thread- and reentrant-safe.
50  */
51 long cdrand_range(long min, long max);
52
53 #endif /* !UTILS_RANDOM_H */