blob: 67af27a9edf37a82316c115fd4a8d2ac2d5f66c9 (
plain)
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
|
// Copyright (C) 2003 Davis E. King (davis@dlib.net)
// License: Boost Software License See LICENSE.txt for the full license.
#undef DLIB_RAND_KERNEl_ABSTRACT_
#ifdef DLIB_RAND_KERNEl_ABSTRACT_
#include <string>
#include "../uintn.h"
namespace dlib
{
class rand
{
/*!
INITIAL VALUE
get_seed() == ""
WHAT THIS OBJECT REPRESENTS
This object represents a pseudorandom number generator.
!*/
public:
rand(
);
/*!
ensures
- #*this is properly initialized
throws
- std::bad_alloc
!*/
rand (
time_t seed_value
);
/*!
ensures
- #*this is properly initialized
- #get_seed() == cast_to_string(seed_value)
- This version of the constructor is equivalent to using
the default constructor and then calling set_seed(cast_to_string(seed_value))
throws
- std::bad_alloc
!*/
rand (
const std::string& seed_value
);
/*!
ensures
- #*this is properly initialized
- #get_seed() == seed_value
- This version of the constructor is equivalent to using
the default constructor and then calling set_seed(seed_value)
throws
- std::bad_alloc
!*/
virtual ~rand(
);
/*!
ensures
- all memory associated with *this has been released
!*/
void clear(
);
/*!
ensures
- #*this has its initial value
throws
- std::bad_alloc
if this exception is thrown then *this is unusable
until clear() is called and succeeds
!*/
const std::string& get_seed (
);
/*!
ensures
- returns the string currently being used as the random seed.
!*/
void set_seed (
const std::string& value
);
/*!
ensures
- #get_seed() == value
!*/
unsigned char get_random_8bit_number (
);
/*!
ensures
- returns a pseudorandom number in the range 0 to 255
!*/
uint16 get_random_16bit_number (
);
/*!
ensures
- returns a pseudorandom number in the range 0 to 2^16-1
!*/
uint32 get_random_32bit_number (
);
/*!
ensures
- returns a pseudorandom number in the range 0 to 2^32-1
!*/
uint64 get_random_64bit_number (
);
/*!
ensures
- returns a pseudorandom number in the range 0 to 2^64-1
!*/
float get_random_float (
);
/*!
ensures
- returns a random float number N where: 0.0 <= N < 1.0.
!*/
double get_random_double (
);
/*!
ensures
- returns a random double number N where: 0.0 <= N < 1.0.
!*/
double get_double_in_range (
double begin,
double end
);
/*!
requires
- begin <= end
ensures
- if (begin < end) then
- returns a random double number N where: begin <= N < end.
- else
- returns begin
!*/
long long get_integer_in_range(
long long begin,
long long end
);
/*!
requires
- begin <= end
ensures
- returns a random integer selected from the range: begin <= N < end
The integer is selected uniformly at random.
!*/
long long get_integer(
long long end
);
/*!
requires
- 0 <= end
ensures
- returns get_integer_in_range(0,end)
!*/
double get_random_gaussian (
);
/*!
ensures
- returns a random number sampled from a Gaussian distribution
with mean 0 and standard deviation 1.
!*/
void swap (
rand& item
);
/*!
ensures
- swaps *this and item
!*/
};
inline void swap (
rand& a,
rand& b
) { a.swap(b); }
/*!
provides a global swap function
!*/
void serialize (
const rand& item,
std::ostream& out
);
/*!
provides serialization support
!*/
void deserialize (
rand& item,
std::istream& in
);
/*!
provides deserialization support
!*/
}
#endif // DLIB_RAND_KERNEl_ABSTRACT_
|
