File: random.h

package info (click to toggle)
graphviz 14.0.5-2
  • links: PTS
  • area: main
  • in suites: forky, sid
  • size: 139,388 kB
  • sloc: ansic: 141,938; cpp: 11,957; python: 7,766; makefile: 4,043; yacc: 3,030; xml: 2,972; tcl: 2,495; sh: 1,388; objc: 1,159; java: 560; lex: 423; perl: 243; awk: 156; pascal: 139; php: 58; ruby: 49; cs: 31; sed: 1
file content (42 lines) | stat: -rw-r--r-- 1,206 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
/// @file
/// @brief random number generation

#pragma once

#include <stdint.h>
#include <util/api.h>

#ifdef __cplusplus
extern "C" {
#endif

/// generate a random permutation of the numbers `[0, bound - 1]`
///
/// The caller is responsible for `free`ing the returned array. This function
/// calls `exit` on memory allocation failure.
///
/// @param bound Exclusive upper bound on the sequence
/// @return A permutation of `[0, bound - 1]`
UTIL_API int *gv_permutation(int bound);

/// generate a random number in the range `[0, bound - 1]`
///
/// This function assumes the caller has previously seeded the `rand` random
/// number generator.
///
/// @param bound Exclusive upper bound on random number generation
/// @return A random number drawn from a uniform distribution
UTIL_API int gv_random(int bound);

/// generate a random 64-bit unsigned number in the range `[0, bound - 1]`
///
/// This function assumes the caller has previously seeded the `rand` random
/// number generator.
///
/// @param bound Exclusive upper bound on random number generation
/// @return A random number drawn from a uniform distribution
UTIL_API uint64_t gv_random_u64(uint64_t bound);

#ifdef __cplusplus
}
#endif