octave: liboctave/numeric/oct-rand.h annotate

annotate liboctave/numeric/oct-rand.h @ 24856:8bb0251fcfde

Use a uint32 state vector for random number generators (bug #50256). * oct-rand.h: Remove #include "dColVector.h" and replace with #include "uint32NDArray.h". Replace all instances of ColumnVector with uint32NDArray. * oct-rand.cc: Replace all instances of ColumnVector with uint32NDArray. * oct-rand.cc (get_internal_state): Remove use of OCTAVE_LOCAL_BUFFER. Use s.fortran_vec () to pass pointer to state vector data directly to oct_get_state(). * oct-rand.cc (set_internal_state): Remove use of OCTAVE_LOCAL_BUFFER. Use s.data () to pass const pointer to state vector data directly to oct_set_state(). * oct-rand.cc (double2uint32): Remove obsolete function. * randmtzig.h (oct_init_by_int): Change prototype to accept const value. * randmtzig.h (oct_init_by_array): Change prototype to accept const value. * randmtzig.h (oct_set_state): Change prototype to accept const value. * randmtzig.cc (oct_init_by_int, oct_init_by_array, oct_set_state): Change functions to match new prototypes. Declare temporary loop variable just-in-time. * randmtzig.cc (oct_get_state, oct_set_state): Use std::copy_n instead of for loop to simplify code. * rand.cc (Frand, Frandn, Frande, Frandg, Frandp): Change tolerances for BIST tests which use the new RNG to be much tighter. Use '_' in large numbers for readability. Change out-of-range seed testing to match new behavior.

author	Rik <rik@octave.org>
date	Fri, 09 Mar 2018 16:40:12 -0800
parents	194eb4bd202b
children	6652d3823428

rev	line source
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	1 /*
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	2
23219 3ac9f9ecfae5 maint: Update copyright dates. John W. Eaton <jwe@octave.org> parents: 23083 diff changeset	3 Copyright (C) 2003-2017 John W. Eaton
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	4
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	5 This file is part of Octave.
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	6
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23795 diff changeset	7 Octave is free software: you can redistribute it and/or modify it
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	8 under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23795 diff changeset	9 the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	10 (at your option) any later version.
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	11
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	12 Octave is distributed in the hope that it will be useful, but
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	13 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	14 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	15 GNU General Public License for more details.
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	16
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	17 You should have received a copy of the GNU General Public License
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 6108 diff changeset	18 along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23795 diff changeset	19 <https://www.gnu.org/licenses/>.
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	20
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	21 */
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	22
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	23 #if ! defined (octave_oct_rand_h)
17822 ebb3ef964372 maint: Use common #define syntax "octave_filename_h" in h_files. Rik <rik@octave.org> parents: 17769 diff changeset	24 #define octave_oct_rand_h 1
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	25
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	26 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	27
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	28 #include <map>
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	29 #include <string>
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	30
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	31 #include "Array.h"
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	32 #include "dNDArray.h"
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	33 #include "fNDArray.h"
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	34 #include "lo-ieee.h"
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	35 #include "uint32NDArray.h"
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	36
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	37 //class dim_vector;
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	38
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	39 class
6108 143b556ce725 [project @ 2006-10-27 01:45:54 by jwe] jwe parents: 5730 diff changeset	40 OCTAVE_API
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	41 octave_rand
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	42 {
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	43 protected:
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	44
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	45 octave_rand (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	46
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	47 public:
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	48
22868 87e3163f6c87 use c++11 "= default" syntax for declaration of trivial destructors John W. Eaton <jwe@octave.org> parents: 22755 diff changeset	49 ~octave_rand (void) = default;
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	50
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	51 static bool instance_ok (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	52
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	53 // Return the current seed.
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	54 static double seed (void)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	55 {
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	56 return instance_ok () ? instance->do_seed ()
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	57 : octave::numeric_limits<double>::NaN ();
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	58 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	59
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	60 // Set the seed.
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	61 static void seed (double s)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	62 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	63 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	64 instance->do_seed (s);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	65 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	66
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	67 // Reset the seed.
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	68 static void reset (void)
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	69 {
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	70 if (instance_ok ())
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	71 instance->do_reset ();
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	72 }
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	73
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	74 // Return the current state.
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	75 static uint32NDArray state (const std::string& d = "")
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	76 {
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	77 return instance_ok () ? instance->do_state (d) : uint32NDArray ();
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	78 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	79
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	80 // Set the current state/
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	81 static void state (const uint32NDArray& s,
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	82 const std::string& d = "")
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	83 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	84 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	85 instance->do_state (s, d);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	86 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	87
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	88 // Reset the current state/
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	89 static void reset (const std::string& d)
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	90 {
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	91 if (instance_ok ())
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	92 instance->do_reset (d);
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	93 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	94
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	95 // Return the current distribution.
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	96 static std::string distribution (void)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	97 {
21017 93748bcaec17 maint: Replace emtpy 'std::string ()' calls with "". Rik <rik@octave.org> parents: 20791 diff changeset	98 return instance_ok () ? instance->do_distribution () : "";
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	99 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	100
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	101 // Set the current distribution. May be either "uniform" (the
7533 ff52243af934 save state separately for each MT random number generator John W. Eaton <jwe@octave.org> parents: 7017 diff changeset	102 // default), "normal", "exponential", "poisson", or "gamma".
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	103 static void distribution (const std::string& d)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	104 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	105 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	106 instance->do_distribution (d);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	107 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	108
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	109 static void uniform_distribution (void)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	110 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	111 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	112 instance->do_uniform_distribution ();
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	113 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	114
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	115 static void normal_distribution (void)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	116 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	117 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	118 instance->do_normal_distribution ();
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	119 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	120
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	121 static void exponential_distribution (void)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	122 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	123 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	124 instance->do_exponential_distribution ();
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	125 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	126
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	127 static void poisson_distribution (void)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	128 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	129 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	130 instance->do_poisson_distribution ();
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	131 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	132
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	133 static void gamma_distribution (void)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	134 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	135 if (instance_ok ())
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	136 instance->do_gamma_distribution ();
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	137 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	138
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	139 // Return the next number from the sequence.
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	140 static double scalar (double a = 1.0)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	141 {
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	142 return instance_ok () ? instance->do_scalar (a)
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	143 : octave::numeric_limits<double>::NaN ();
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	144 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	145
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	146 // Return the next number from the sequence.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	147 static float float_scalar (float a = 1.0)
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	148 {
22402 4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	149 return instance_ok () ? instance->do_float_scalar (a)
4caa7b28d183 maint: Style check C++ code in liboctave/ Rik <rik@octave.org> parents: 22323 diff changeset	150 : octave::numeric_limits<float>::NaN ();
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	151 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	152
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	153 // Return an array of numbers from the sequence.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	154 static Array<double> vector (octave_idx_type n, double a = 1.0)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	155 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	156 return instance_ok () ? instance->do_vector (n, a) : Array<double> ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	157 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	158
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	159 // Return an array of numbers from the sequence.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	160 static Array<float> float_vector (octave_idx_type n, float a = 1.0)
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	161 {
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	162 return instance_ok () ? instance->do_float_vector (n, a) : Array<float> ();
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	163 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	164
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	165 // Return an N-dimensional array of numbers from the sequence,
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	166 // filled in column major order.
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	167 static NDArray nd_array (const dim_vector& dims, double a = 1.0)
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	168 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	169 return instance_ok () ? instance->do_nd_array (dims, a) : NDArray ();
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	170 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	171
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	172 // Return an N-dimensional array of numbers from the sequence,
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	173 // filled in column major order.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	174 static FloatNDArray float_nd_array (const dim_vector& dims, float a = 1.0)
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	175 {
17769 49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	176 return instance_ok () ? instance->do_float_nd_array (dims, a)
49a5a4be04a1 maint: Use GNU style coding conventions for code in liboctave/ Rik <rik@octave.org> parents: 17744 diff changeset	177 : FloatNDArray ();
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	178 }
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	179
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	180 private:
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	181
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	182 static octave_rand *instance;
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	183
23795 980f39c3ab90 Use C++11 nullptr rather than 0 in code (bug #51565). Rik <rik@octave.org> parents: 23475 diff changeset	184 static void cleanup_instance (void) { delete instance; instance = nullptr; }
13983 7dd7cccf0757 clean up memory allocated for singletons before exit John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	185
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	186 enum
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	187 {
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	188 unknown_dist,
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	189 uniform_dist,
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	190 normal_dist,
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	191 expon_dist,
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	192 poisson_dist,
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	193 gamma_dist
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	194 };
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	195
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	196 // Current distribution of random numbers.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	197 int current_distribution;
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	198
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	199 // If TRUE, use old RANLIB generators. Otherwise, use Mersenne
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	200 // Twister generator.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	201 bool use_old_generators;
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	202
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	203 // Saved MT states.
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	204 std::map<int, uint32NDArray> rand_states;
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	205
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	206 // Return the current seed.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	207 double do_seed (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	208
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	209 // Set the seed.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	210 void do_seed (double s);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	211
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	212 // Reset the seed.
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	213 void do_reset ();
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	214
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	215 // Return the current state.
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	216 uint32NDArray do_state (const std::string& d);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	217
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	218 // Set the current state/
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	219 void do_state (const uint32NDArray& s, const std::string& d);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	220
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	221 // Reset the current state/
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	222 void do_reset (const std::string& d);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	223
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	224 // Return the current distribution.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	225 std::string do_distribution (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	226
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	227 // Set the current distribution. May be either "uniform" (the
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	228 // default), "normal", "exponential", "poisson", or "gamma".
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	229 void do_distribution (const std::string& d);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	230
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	231 void do_uniform_distribution (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	232
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	233 void do_normal_distribution (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	234
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	235 void do_exponential_distribution (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	236
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	237 void do_poisson_distribution (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	238
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	239 void do_gamma_distribution (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	240
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	241 // Return the next number from the sequence.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	242 double do_scalar (double a = 1.);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	243
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	244 // Return the next number from the sequence.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	245 float do_float_scalar (float a = 1.);
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	246
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	247 // Return an array of numbers from the sequence.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	248 Array<double> do_vector (octave_idx_type n, double a = 1.);
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	249
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	250 // Return an array of numbers from the sequence.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	251 Array<float> do_float_vector (octave_idx_type n, float a = 1.);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	252
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	253 // Return an N-dimensional array of numbers from the sequence,
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	254 // filled in column major order.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	255 NDArray do_nd_array (const dim_vector& dims, double a = 1.);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	256
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	257 // Return an N-dimensional array of numbers from the sequence,
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	258 // filled in column major order.
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	259 FloatNDArray do_float_nd_array (const dim_vector& dims, float a = 1.);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	260
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	261 // Some helper functions.
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	262
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	263 void initialize_ranlib_generators (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	264
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	265 void initialize_mersenne_twister (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	266
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	267 uint32NDArray get_internal_state (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	268
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	269 void save_state (void);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	270
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	271 int get_dist_id (const std::string& d);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	272
24856 8bb0251fcfde Use a uint32 state vector for random number generators (bug #50256). Rik <rik@octave.org> parents: 24534 diff changeset	273 void set_internal_state (const uint32NDArray& s);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	274
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	275 void switch_to_generator (int dist);
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	276
a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	277 void fill (octave_idx_type len, double *v, double a);
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	278
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	279 void fill (octave_idx_type len, float *v, float a);
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	280 };
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	281
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	282 #endif

Mercurial > octave

annotate liboctave/numeric/oct-rand.h @ 24856:8bb0251fcfde