|
2928
|
1 /* |
|
|
2 |
|
|
3 Copyright (C) 1996, 1997 John W. Eaton |
|
|
4 |
|
|
5 This file is part of Octave. |
|
|
6 |
|
|
7 Octave is free software; you can redistribute it and/or modify it |
|
|
8 under the terms of the GNU General Public License as published by the |
|
|
9 Free Software Foundation; either version 2, or (at your option) any |
|
|
10 later version. |
|
|
11 |
|
|
12 Octave is distributed in the hope that it will be useful, but WITHOUT |
|
|
13 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or |
|
|
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License |
|
|
15 for more details. |
|
|
16 |
|
|
17 You should have received a copy of the GNU General Public License |
|
|
18 along with Octave; see the file COPYING. If not, write to the Free |
|
|
19 Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. |
|
|
20 |
|
|
21 */ |
|
|
22 |
|
|
23 #ifdef HAVE_CONFIG_H |
|
|
24 #include <config.h> |
|
|
25 #endif |
|
|
26 |
|
|
27 #include <ctime> |
|
|
28 |
|
|
29 #include <string> |
|
|
30 |
|
|
31 #include "f77-fcn.h" |
|
|
32 #include "lo-mappers.h" |
|
|
33 |
|
|
34 #include "defun-dld.h" |
|
|
35 #include "error.h" |
|
|
36 #include "gripes.h" |
|
|
37 #include "oct-obj.h" |
|
|
38 #include "unwind-prot.h" |
|
|
39 #include "utils.h" |
|
|
40 |
|
|
41 // Possible distributions of random numbers. This was handled with an |
|
|
42 // enum, but unwind_protecting that doesn't work so well. |
|
|
43 #define uniform_dist 1 |
|
|
44 #define normal_dist 2 |
|
|
45 |
|
|
46 // Current distribution of random numbers. |
|
|
47 static int current_distribution = uniform_dist; |
|
|
48 |
|
|
49 // Has the seed been set yet? |
|
|
50 static int initialized = 0; |
|
|
51 |
|
|
52 extern "C" |
|
|
53 { |
|
3189
|
54 int F77_FCN (dgennor, DGENNOR) (const double&, const double&, |
|
|
55 double&); |
|
2928
|
56 |
|
3189
|
57 int F77_FCN (dgenunf, DGENUNF) (const double&, const double&, |
|
|
58 double&); |
|
2928
|
59 |
|
3189
|
60 int F77_FCN (setall, SETALL) (const int&, const int&); |
|
2928
|
61 |
|
3189
|
62 int F77_FCN (getsd, GETSD) (int&, int&); |
|
2928
|
63 |
|
3189
|
64 int F77_FCN (setsd, SETSD) (const int&, const int&); |
|
2928
|
65 |
|
3189
|
66 int F77_FCN (setcgn, SETCGN) (const int&); |
|
2928
|
67 } |
|
|
68 |
|
|
69 static double |
|
|
70 curr_rand_seed (void) |
|
|
71 { |
|
|
72 union d2i { double d; int i[2]; }; |
|
|
73 union d2i u; |
|
3074
|
74 F77_XFCN (getsd, GETSD, (u.i[0], u.i[1])); |
|
2928
|
75 return u.d; |
|
|
76 } |
|
|
77 |
|
|
78 static int |
|
|
79 force_to_fit_range (int i, int lo, int hi) |
|
|
80 { |
|
|
81 assert (hi > lo && lo >= 0 && hi > lo); |
|
|
82 |
|
|
83 i = i > 0 ? i : -i; |
|
|
84 |
|
|
85 if (i < lo) |
|
|
86 i = lo; |
|
|
87 else if (i > hi) |
|
|
88 i = i % hi; |
|
|
89 |
|
|
90 return i; |
|
|
91 } |
|
|
92 |
|
|
93 static void |
|
|
94 set_rand_seed (double val) |
|
|
95 { |
|
|
96 union d2i { double d; int i[2]; }; |
|
|
97 union d2i u; |
|
|
98 u.d = val; |
|
|
99 int i0 = force_to_fit_range (u.i[0], 1, 2147483563); |
|
|
100 int i1 = force_to_fit_range (u.i[1], 1, 2147483399); |
|
3074
|
101 F77_XFCN (setsd, SETSD, (i0, i1)); |
|
2928
|
102 } |
|
|
103 |
|
|
104 static char * |
|
|
105 curr_rand_dist (void) |
|
|
106 { |
|
|
107 if (current_distribution == uniform_dist) |
|
|
108 return "uniform"; |
|
|
109 else if (current_distribution == normal_dist) |
|
|
110 return "normal"; |
|
|
111 else |
|
|
112 { |
|
|
113 panic_impossible (); |
|
|
114 return 0; |
|
|
115 } |
|
|
116 } |
|
|
117 |
|
|
118 // Make the random number generator give us a different sequence every |
|
|
119 // time we start octave unless we specifically set the seed. The |
|
|
120 // technique used below will cycle monthly, but it it does seem to |
|
|
121 // work ok to give fairly different seeds each time Octave starts. |
|
|
122 |
|
|
123 static void |
|
|
124 do_initialization (void) |
|
|
125 { |
|
|
126 time_t now; |
|
|
127 struct tm *tm; |
|
|
128 |
|
|
129 time (&now); |
|
|
130 tm = localtime (&now); |
|
|
131 |
|
|
132 int hour = tm->tm_hour + 1; |
|
|
133 int minute = tm->tm_min + 1; |
|
|
134 int second = tm->tm_sec + 1; |
|
|
135 |
|
|
136 int s0 = tm->tm_mday * hour * minute * second; |
|
|
137 int s1 = hour * minute * second; |
|
|
138 |
|
|
139 s0 = force_to_fit_range (s0, 1, 2147483563); |
|
|
140 s1 = force_to_fit_range (s1, 1, 2147483399); |
|
|
141 |
|
3074
|
142 F77_XFCN (setall, SETALL, (s0, s1)); |
|
2928
|
143 |
|
|
144 initialized = 1; |
|
|
145 } |
|
|
146 |
|
|
147 static octave_value_list |
|
|
148 do_rand (const octave_value_list& args, int nargin) |
|
|
149 { |
|
|
150 octave_value_list retval; |
|
|
151 |
|
3157
|
152 volatile int n = 0; |
|
|
153 volatile int m = 0; |
|
2928
|
154 |
|
|
155 if (nargin == 0) |
|
|
156 { |
|
|
157 n = 1; |
|
|
158 m = 1; |
|
|
159 |
|
|
160 goto gen_matrix; |
|
|
161 } |
|
|
162 else if (nargin == 1) |
|
|
163 { |
|
|
164 octave_value tmp = args(0); |
|
|
165 |
|
|
166 if (tmp.is_string ()) |
|
|
167 { |
|
|
168 string s_arg = tmp.string_value (); |
|
|
169 |
|
|
170 if (s_arg == "dist") |
|
|
171 { |
|
|
172 retval(0) = curr_rand_dist (); |
|
|
173 } |
|
|
174 else if (s_arg == "seed") |
|
|
175 { |
|
|
176 retval(0) = curr_rand_seed (); |
|
|
177 } |
|
|
178 else if (s_arg == "uniform") |
|
|
179 { |
|
|
180 current_distribution = uniform_dist; |
|
|
181 |
|
3074
|
182 F77_XFCN (setcgn, SETCGN, (uniform_dist)); |
|
2928
|
183 } |
|
|
184 else if (s_arg == "normal") |
|
|
185 { |
|
|
186 current_distribution = normal_dist; |
|
|
187 |
|
3074
|
188 F77_XFCN (setcgn, SETCGN, (normal_dist)); |
|
2928
|
189 } |
|
|
190 else |
|
|
191 error ("rand: unrecognized string argument"); |
|
|
192 } |
|
|
193 else if (tmp.is_scalar_type ()) |
|
|
194 { |
|
|
195 double dval = tmp.double_value (); |
|
|
196 |
|
|
197 if (xisnan (dval)) |
|
|
198 { |
|
|
199 error ("rand: NaN is invalid a matrix dimension"); |
|
|
200 } |
|
|
201 else |
|
|
202 { |
|
|
203 m = n = NINT (tmp.double_value ()); |
|
|
204 |
|
|
205 if (! error_state) |
|
|
206 goto gen_matrix; |
|
|
207 } |
|
|
208 } |
|
|
209 else if (tmp.is_range ()) |
|
|
210 { |
|
|
211 Range r = tmp.range_value (); |
|
|
212 n = 1; |
|
|
213 m = r.nelem (); |
|
|
214 goto gen_matrix; |
|
|
215 } |
|
|
216 else if (tmp.is_matrix_type ()) |
|
|
217 { |
|
|
218 // XXX FIXME XXX -- this should probably use the function |
|
|
219 // from data.cc. |
|
|
220 |
|
|
221 Matrix a = args(0).matrix_value (); |
|
|
222 |
|
|
223 if (error_state) |
|
|
224 return retval; |
|
|
225 |
|
|
226 n = a.rows (); |
|
|
227 m = a.columns (); |
|
|
228 |
|
|
229 if (n == 1 && m == 2) |
|
|
230 { |
|
|
231 n = NINT (a (0, 0)); |
|
|
232 m = NINT (a (0, 1)); |
|
|
233 } |
|
|
234 else if (n == 2 && m == 1) |
|
|
235 { |
|
|
236 n = NINT (a (0, 0)); |
|
|
237 m = NINT (a (1, 0)); |
|
|
238 } |
|
|
239 else |
|
|
240 warning ("rand (A): use rand (size (A)) instead"); |
|
|
241 |
|
|
242 goto gen_matrix; |
|
|
243 } |
|
|
244 else |
|
|
245 { |
|
|
246 gripe_wrong_type_arg ("rand", tmp); |
|
|
247 return retval; |
|
|
248 } |
|
|
249 } |
|
|
250 else if (nargin == 2) |
|
|
251 { |
|
|
252 if (args(0).is_string ()) |
|
|
253 { |
|
|
254 if (args(0).string_value () == "seed") |
|
|
255 { |
|
|
256 double d = args(1).double_value (); |
|
|
257 |
|
|
258 if (! error_state) |
|
|
259 set_rand_seed (d); |
|
|
260 } |
|
3086
|
261 else |
|
|
262 error ("rand: unrecognized string argument"); |
|
2928
|
263 } |
|
|
264 else |
|
|
265 { |
|
|
266 double dval = args(0).double_value (); |
|
|
267 |
|
|
268 if (xisnan (dval)) |
|
|
269 { |
|
|
270 error ("rand: NaN is invalid as a matrix dimension"); |
|
|
271 } |
|
|
272 else |
|
|
273 { |
|
|
274 n = NINT (dval); |
|
|
275 |
|
|
276 if (! error_state) |
|
|
277 { |
|
|
278 m = NINT (args(1).double_value ()); |
|
|
279 |
|
|
280 if (! error_state) |
|
|
281 goto gen_matrix; |
|
|
282 } |
|
|
283 } |
|
|
284 } |
|
|
285 } |
|
|
286 |
|
|
287 return retval; |
|
|
288 |
|
|
289 gen_matrix: |
|
|
290 |
|
|
291 if (n == 0 || m == 0) |
|
|
292 { |
|
|
293 Matrix m; |
|
|
294 retval.resize (1, m); |
|
|
295 } |
|
|
296 else if (n > 0 && m > 0) |
|
|
297 { |
|
3157
|
298 volatile int i; |
|
|
299 volatile int j; |
|
|
300 |
|
2928
|
301 Matrix rand_mat (n, m); |
|
3157
|
302 |
|
|
303 for (j = 0; j < m; j++) |
|
|
304 for (i = 0; i < n; i++) |
|
2928
|
305 { |
|
|
306 double val; |
|
|
307 switch (current_distribution) |
|
|
308 { |
|
|
309 case uniform_dist: |
|
3074
|
310 F77_XFCN (dgenunf, DGENUNF, (0.0, 1.0, val)); |
|
2928
|
311 rand_mat (i, j) = val; |
|
|
312 break; |
|
|
313 |
|
|
314 case normal_dist: |
|
3074
|
315 F77_XFCN (dgennor, DGENNOR, (0.0, 1.0, val)); |
|
2928
|
316 rand_mat (i, j) = val; |
|
|
317 break; |
|
|
318 |
|
|
319 default: |
|
|
320 panic_impossible (); |
|
|
321 break; |
|
|
322 } |
|
|
323 } |
|
|
324 |
|
|
325 retval(0) = rand_mat; |
|
|
326 } |
|
|
327 else |
|
|
328 error ("rand: invalid negative argument"); |
|
|
329 |
|
|
330 return retval; |
|
|
331 } |
|
|
332 |
|
|
333 DEFUN_DLD (rand, args, nargout, |
|
3088
|
334 "rand -- generate a random value from a uniform distribution\n\ |
|
2928
|
335 \n\ |
|
3088
|
336 rand (N) -- generate N x N matrix\n\ |
|
|
337 rand (size (A)) -- generate matrix the size of A\n\ |
|
|
338 rand (N, M) -- generate N x M matrix\n\ |
|
|
339 rand (\"seed\") -- get current seed\n\ |
|
|
340 rand (\"seed\", N) -- set seed\n\ |
|
2928
|
341 \n\ |
|
|
342 See also: randn") |
|
|
343 { |
|
|
344 octave_value_list retval; |
|
|
345 |
|
|
346 int nargin = args.length (); |
|
|
347 |
|
|
348 if (nargin > 2 || nargout > 1) |
|
|
349 print_usage ("rand"); |
|
|
350 else |
|
|
351 { |
|
|
352 if (! initialized) |
|
|
353 do_initialization (); |
|
|
354 |
|
|
355 retval = do_rand (args, nargin); |
|
|
356 } |
|
|
357 |
|
|
358 return retval; |
|
|
359 } |
|
|
360 |
|
|
361 static void |
|
|
362 reset_rand_generator (void *) |
|
|
363 { |
|
3074
|
364 F77_XFCN (setcgn, SETCGN, (current_distribution)); |
|
2928
|
365 } |
|
|
366 |
|
|
367 DEFUN_DLD (randn, args, nargout, |
|
3088
|
368 "randn -- generate a random value from a normal distribution\n\ |
|
2928
|
369 \n\ |
|
3088
|
370 randn (N) -- generate N x N matrix\n\ |
|
|
371 randn (size (A)) -- generate matrix the size of A\n\ |
|
|
372 randn (N, M) -- generate N x M matrix\n\ |
|
|
373 randn (\"seed\") -- get current seed\n\ |
|
|
374 randn (\"seed\", N) -- set seed\n\ |
|
2928
|
375 \n\ |
|
|
376 See also: rand") |
|
|
377 { |
|
|
378 octave_value_list retval; |
|
|
379 |
|
|
380 int nargin = args.length (); |
|
|
381 |
|
|
382 if (nargin > 2 || nargout > 1) |
|
|
383 print_usage ("randn"); |
|
|
384 else |
|
|
385 { |
|
|
386 if (! initialized) |
|
|
387 do_initialization (); |
|
|
388 |
|
2985
|
389 unwind_protect::begin_frame ("randn"); |
|
2928
|
390 |
|
|
391 // This relies on the fact that elements are popped from the |
|
|
392 // unwind stack in the reverse of the order they are pushed |
|
|
393 // (i.e. current_distribution will be reset before calling |
|
|
394 // reset_rand_generator()). |
|
|
395 |
|
2985
|
396 unwind_protect::add (reset_rand_generator, 0); |
|
2928
|
397 unwind_protect_int (current_distribution); |
|
|
398 |
|
|
399 current_distribution = normal_dist; |
|
|
400 |
|
3074
|
401 F77_XFCN (setcgn, SETCGN, (normal_dist)); |
|
2928
|
402 |
|
|
403 retval = do_rand (args, nargin); |
|
|
404 |
|
2985
|
405 unwind_protect::run_frame ("randn"); |
|
2928
|
406 } |
|
|
407 |
|
|
408 return retval; |
|
|
409 } |
|
|
410 |
|
|
411 /* |
|
|
412 ;;; Local Variables: *** |
|
|
413 ;;; mode: C++ *** |
|
|
414 ;;; End: *** |
|
|
415 */ |
