A library for working with phylogenetic and population genetic data.
v0.32.0
random.hpp
Go to the documentation of this file.
1 #ifndef GENESIS_UTILS_MATH_RANDOM_H_
2 #define GENESIS_UTILS_MATH_RANDOM_H_
3 
4 /*
5  Genesis - A toolkit for working with phylogenetic data.
6  Copyright (C) 2014-2024 Lucas Czech
7 
8  This program is free software: you can redistribute it and/or modify
9  it under the terms of the GNU General Public License as published by
10  the Free Software Foundation, either version 3 of the License, or
11  (at your option) any later version.
12 
13  This program is distributed in the hope that it will be useful,
14  but WITHOUT ANY WARRANTY; without even the implied warranty of
15  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16  GNU General Public License for more details.
17 
18  You should have received a copy of the GNU General Public License
19  along with this program. If not, see <http://www.gnu.org/licenses/>.
20 
21  Contact:
22  Lucas Czech <lczech@carnegiescience.edu>
23  Department of Plant Biology, Carnegie Institution For Science
24  260 Panama Street, Stanford, CA 94305, USA
25 */
26 
34 #include <cstddef>
35 #include <cstdint>
36 #include <vector>
37 
38 namespace genesis {
39 namespace utils {
40 
41 // =================================================================================================
42 // Fast Randomness
43 // =================================================================================================
44 
52 
58 uint32_t permuted_congruential_generator( uint32_t max );
59 
65 uint32_t permuted_congruential_generator( uint32_t min, uint32_t max );
66 
71 
79 bool permuted_congruential_generator_bool( uint32_t chance_one_in );
80 
84 void permuted_congruential_generator_init( uint64_t seed );
85 
86 // =================================================================================================
87 // Sampling
88 // =================================================================================================
89 
101 std::vector<size_t> select_without_replacement( size_t k, size_t n );
102 
103 } // namespace utils
104 } // namespace genesis
105 
106 #endif // include guard
genesis::utils::permuted_congruential_generator_init
void permuted_congruential_generator_init(uint64_t seed)
Set the seed for permuted_congruential_generator().
Definition: random.cpp:99
genesis::utils::permuted_congruential_generator_bool
bool permuted_congruential_generator_bool()
Fast random number generator for 32bit integers, for bool with 0.5 probability.
Definition: random.cpp:84
genesis
Container namespace for all symbols of genesis in order to keep them separate when used as a library.
Definition: placement/formats/edge_color.cpp:42
genesis::utils::select_without_replacement
std::vector< size_t > select_without_replacement(size_t const k, size_t const n)
Select k many unique numbers out of the range [ 0, n ).
Definition: random.cpp:108
genesis::utils::permuted_congruential_generator
uint32_t permuted_congruential_generator()
Fast random number generator for 32bit integers.
Definition: random.cpp:58