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

annotate liboctave/numeric/oct-rand.h @ 27919:1891570abac8

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2020.

author	John W. Eaton <jwe@octave.org>
date	Mon, 06 Jan 2020 22:29:51 -0500
parents	b442ec6dda5c
children	bd51beb6205e

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
27919 1891570abac8 update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 27918 diff changeset	3 Copyright (C) 2003-2020 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27102 diff changeset	4
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27102 diff changeset	5 See the file COPYRIGHT.md in the top-level directory of this distribution
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27102 diff changeset	6 or <https://octave.org/COPYRIGHT.html/>.
b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27102 diff changeset	7
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	8
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	9 This file is part of Octave.
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	10
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23795 diff changeset	11 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	12 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	13 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	14 (at your option) any later version.
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	15
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	16 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	17 WITHOUT ANY WARRANTY; without even the implied warranty of
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22402 diff changeset	19 GNU General Public License for more details.
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 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	22 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	23 <https://www.gnu.org/licenses/>.
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	24
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	25 */
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	26
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	27 #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	28 #define octave_oct_rand_h 1
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	29
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	30 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	31
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	32 #include <map>
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	33 #include <string>
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	34
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	35 #include "Array.h"
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	36 #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	37 #include "fNDArray.h"
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	38 #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	39 #include "uint32NDArray.h"
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	40
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	41 //class dim_vector;
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	42
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	43 namespace octave
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	44 {
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	45 class OCTAVE_API rand
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	46 {
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	47 protected:
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	48
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	49 rand (void);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	50
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	51 public:
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	52
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	53 ~rand (void) = default;
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	54
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	55 static bool instance_ok (void);
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	56
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	57 // Return the current seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	58 static double seed (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	59 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	60 return (instance_ok ()
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	61 ? instance->do_seed () : numeric_limits<double>::NaN ());
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	62 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	63
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	64 // Set the seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	65 static void seed (double s)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	66 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	67 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	68 instance->do_seed (s);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	69 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	70
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	71 // Reset the seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	72 static void reset (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	73 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	74 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	75 instance->do_reset ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	76 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	77
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	78 // Return the current state.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	79 static uint32NDArray state (const std::string& d = "")
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	80 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	81 return instance_ok () ? instance->do_state (d) : uint32NDArray ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	82 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	83
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	84 // Set the current state/
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	85 static void state (const uint32NDArray& s,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	86 const std::string& d = "")
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	87 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	88 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	89 instance->do_state (s, d);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	90 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	91
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	92 // Reset the current state/
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	93 static void reset (const std::string& d)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	94 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	95 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	96 instance->do_reset (d);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	97 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	98
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	99 // Return the current distribution.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	100 static std::string distribution (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	101 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	102 return instance_ok () ? instance->do_distribution () : "";
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	103 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	104
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	105 // Set the current distribution. May be either "uniform" (the
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	106 // default), "normal", "exponential", "poisson", or "gamma".
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	107 static void distribution (const std::string& d)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	108 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	109 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	110 instance->do_distribution (d);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	111 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	112
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	113 static void uniform_distribution (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	114 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	115 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	116 instance->do_uniform_distribution ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	117 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	118
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	119 static void normal_distribution (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	120 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	121 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	122 instance->do_normal_distribution ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	123 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	124
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	125 static void exponential_distribution (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	126 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	127 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	128 instance->do_exponential_distribution ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	129 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	130
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	131 static void poisson_distribution (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	132 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	133 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	134 instance->do_poisson_distribution ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	135 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	136
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	137 static void gamma_distribution (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	138 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	139 if (instance_ok ())
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	140 instance->do_gamma_distribution ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	141 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	142
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	143 // Return the next number from the sequence.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	144 static double scalar (double a = 1.0)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	145 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	146 return (instance_ok ()
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	147 ? instance->do_scalar (a) : numeric_limits<double>::NaN ());
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	148 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	149
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	150 // Return the next number from the sequence.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	151 static float float_scalar (float a = 1.0)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	152 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	153 return (instance_ok ()
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	154 ? instance->do_scalar (a) : numeric_limits<float>::NaN ());
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	155 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	156
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	157 // Return an array of numbers from the sequence.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	158 static Array<double> vector (octave_idx_type n, double a = 1.0)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	159 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	160 return instance_ok () ? instance->do_vector (n, a) : Array<double> ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	161 }
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	162
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	163 // Return an array of numbers from the sequence.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	164 static Array<float> float_vector (octave_idx_type n, float a = 1.0)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	165 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	166 return instance_ok () ? instance->do_vector (n, a) : Array<float> ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	167 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	168
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	169 // Return an N-dimensional array of numbers from the sequence,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	170 // filled in column major order.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	171 static NDArray nd_array (const dim_vector& dims, double a = 1.0)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	172 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	173 return instance_ok () ? instance->do_nd_array (dims, a) : NDArray ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	174 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	175
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	176 // Return an N-dimensional array of numbers from the sequence,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	177 // filled in column major order.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	178 static FloatNDArray float_nd_array (const dim_vector& dims, float a = 1.0)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	179 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	180 return (instance_ok ()
84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	181 ? instance->do_float_nd_array (dims, a) : FloatNDArray ());
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	182 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	183
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	184 private:
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	185
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	186 static rand *instance;
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	187
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	188 static void cleanup_instance (void) { delete instance; instance = nullptr; }
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	189
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	190 enum
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	191 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	192 unknown_dist,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	193 uniform_dist,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	194 normal_dist,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	195 expon_dist,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	196 poisson_dist,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	197 gamma_dist
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	198 };
13983 7dd7cccf0757 clean up memory allocated for singletons before exit John W. Eaton <jwe@octave.org> parents: 11586 diff changeset	199
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	200 // Current distribution of random numbers.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	201 int current_distribution;
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	202
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	203 // If TRUE, use old RANLIB generators. Otherwise, use Mersenne
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	204 // Twister generator.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	205 bool use_old_generators;
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	206
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	207 // Saved MT states.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	208 std::map<int, uint32NDArray> rand_states;
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	209
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	210 // Return the current seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	211 double do_seed (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	212
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	213 // Set the seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	214 void do_seed (double s);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	215
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	216 // Reset the seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	217 void do_reset ();
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	218
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	219 // Return the current state.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	220 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	221
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	222 // Set the current state/
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	223 void do_state (const uint32NDArray& s, const std::string& d);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	224
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	225 // Reset the current state/
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	226 void do_reset (const std::string& d);
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10312 diff changeset	227
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	228 // Return the current distribution.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	229 std::string do_distribution (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	230
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	231 // Set the current distribution. May be either "uniform" (the
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	232 // default), "normal", "exponential", "poisson", or "gamma".
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	233 void do_distribution (const std::string& d);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	234
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	235 void do_uniform_distribution (void);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	236
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	237 void do_normal_distribution (void);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	238
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	239 void do_exponential_distribution (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	240
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	241 void do_poisson_distribution (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	242
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	243 void do_gamma_distribution (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	244
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	245 // The following templates only make sense for double and float
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	246 // types.
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	247
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	248 template <typename T> T uniform (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	249
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	250 template <typename T> T normal (void);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	251
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	252 template <typename T> T exponential (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	253
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	254 template <typename T> T poisson (T a);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	255
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	256 template <typename T> T gamma (T a);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	257
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	258 // Return the next number from the sequence.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	259 template <typename T> T do_scalar (T a = 1);
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	260
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	261 // Return an array of numbers from the sequence.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	262 template <typename T> Array<T> do_vector (octave_idx_type n, T a = 1);
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	263
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	264 // Return an N-dimensional array of numbers from the sequence,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	265 // filled in column major order.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	266 NDArray do_nd_array (const dim_vector& dims, double a = 1.);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	267
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	268 // Return an N-dimensional array of numbers from the sequence,
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	269 // filled in column major order.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	270 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	271
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	272 // Some helper functions.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	273
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	274 void initialize_ranlib_generators (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	275
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	276 void initialize_mersenne_twister (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	277
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	278 uint32NDArray get_internal_state (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	279
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	280 void save_state (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	281
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	282 int get_dist_id (const std::string& d);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	283
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	284 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	285
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	286 void switch_to_generator (int dist);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	287
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	288 void fill (octave_idx_type len, double *v, double a);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	289
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	290 void fill (octave_idx_type len, float *v, float a);
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	291 };
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	292 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	293
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	294 #endif

Mercurial > octave

annotate liboctave/numeric/oct-rand.h @ 27919:1891570abac8