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

annotate liboctave/numeric/oct-rand.h @ 30564:796f54d4ddbf stable

update Octave Project Developers copyright for the new year In files that have the "Octave Project Developers" copyright notice, update for 2021. In all .txi and .texi files except gpl.txi and gpl.texi in the doc/liboctave and doc/interpreter directories, change the copyright to "Octave Project Developers", the same as used for other source files. Update copyright notices for 2022 (not done since 2019). For gpl.txi and gpl.texi, change the copyright notice to be "Free Software Foundation, Inc." and leave the date at 2007 only because this file only contains the text of the GPL, not anything created by the Octave Project Developers. Add Paul Thomas to contributors.in.

author	John W. Eaton <jwe@octave.org>
date	Tue, 28 Dec 2021 18:22:40 -0500
parents	cc7ca74e883d
children	e88a07dec498

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ////////////////////////////////////////////////////////////////////////
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 //
30564 796f54d4ddbf update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 30059 diff changeset	3 // Copyright (C) 2003-2022 The Octave Project Developers
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	4 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 // See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 // distribution or <https://octave.org/copyright/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	7 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	9 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	14 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	19 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	22 // <https://www.gnu.org/licenses/>.
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 //
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ////////////////////////////////////////////////////////////////////////
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	25
20791 f7084eae3318 maint: Use Octave coding conventions for #if statements. Rik <rik@octave.org> parents: 19697 diff changeset	26 #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	27 #define octave_oct_rand_h 1
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	28
21244 1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	29 #include "octave-config.h"
1473547f50f5 include octave-config.h in public header files John W. Eaton <jwe@octave.org> parents: 21017 diff changeset	30
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	31 #include <map>
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	32 #include <string>
b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	33
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	34 #include "Array.h"
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	35 #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	36 #include "fNDArray.h"
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	37 #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	38 #include "uint32NDArray.h"
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	39
23475 d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	40 //class dim_vector;
d691ed308237 maint: Clean up #includes in liboctave/numeric directory. Rik <rik@octave.org> parents: 23433 diff changeset	41
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	42 namespace octave
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	43 {
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	44 class OCTAVE_API rand
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	45 {
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	46 protected:
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	47
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	48 OCTAVE_API rand (void);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	49
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	50 public:
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	51
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	52 ~rand (void) = default;
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	53
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	54 static bool instance_ok (void);
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	55
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	56 // Return the current seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	57 static double seed (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	58 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	59 return (instance_ok ()
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	60 ? m_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	61 }
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 // Set the seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	64 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	65 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	66 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	67 m_instance->do_seed (s);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	68 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	69
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	70 // Reset the seed.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	71 static void reset (void)
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	72 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	73 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	74 m_instance->do_reset ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	75 }
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 // Return the current state.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	78 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	79 {
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	80 return instance_ok () ? m_instance->do_state (d) : uint32NDArray ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	81 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	82
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	83 // Set the current state/
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	84 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	85 const std::string& d = "")
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	86 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	87 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	88 m_instance->do_state (s, d);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	89 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	90
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	91 // Reset the current state/
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	92 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	93 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	94 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	95 m_instance->do_reset (d);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	96 }
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 // Return the current distribution.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	99 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	100 {
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	101 return instance_ok () ? m_instance->do_distribution () : "";
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	102 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	103
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	104 // 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	105 // 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	106 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	107 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	108 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	109 m_instance->do_distribution (d);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	110 }
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 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	113 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	114 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	115 m_instance->do_uniform_distribution ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	116 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	117
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	118 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	119 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	120 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	121 m_instance->do_normal_distribution ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	122 }
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 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	125 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	126 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	127 m_instance->do_exponential_distribution ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	128 }
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 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	131 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	132 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	133 m_instance->do_poisson_distribution ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	134 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5307 diff changeset	135
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	136 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	137 {
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	138 if (instance_ok ())
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	139 m_instance->do_gamma_distribution ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	140 }
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 // 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	143 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	144 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	145 return (instance_ok ()
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	146 ? m_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	147 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	148
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	149 // 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	150 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	151 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	152 return (instance_ok ()
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	153 ? m_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	154 }
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	155
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	156 // 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	157 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	158 {
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	159 return instance_ok () ? m_instance->do_vector (n, a) : Array<double> ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	160 }
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 // 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	163 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	164 {
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	165 return instance_ok () ? m_instance->do_vector (n, a) : Array<float> ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	166 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	167
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	168 // 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	169 // 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	170 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	171 {
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	172 return instance_ok () ? m_instance->do_nd_array (dims, a) : NDArray ();
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	173 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	174
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	175 // 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	176 // 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	177 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	178 {
27102 84ff9953faa1 where possible, eliminate octave:: namespace qualifier inside octave namespace John W. Eaton <jwe@octave.org> parents: 26377 diff changeset	179 return (instance_ok ()
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	180 ? m_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	181 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4308 diff changeset	182
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	183 private:
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	184
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	185 static rand *m_instance;
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	186
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	187 static void cleanup_instance (void)
cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	188 { delete m_instance; m_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.
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	201 int m_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.
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	205 bool m_use_old_generators;
25433 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.
30059 cc7ca74e883d maint: use "m_" prefix for member variables in class rand. Rik <rik@octave.org> parents: 29359 diff changeset	208 std::map<int, uint32NDArray> m_rand_states;
25433 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.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	211 OCTAVE_API 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.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	214 OCTAVE_API 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.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	217 OCTAVE_API void do_reset ();
25433 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.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	220 OCTAVE_API 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/
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	223 OCTAVE_API 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/
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	226 OCTAVE_API 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.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	229 OCTAVE_API 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".
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	233 OCTAVE_API 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
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	235 OCTAVE_API void do_uniform_distribution (void);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11523 diff changeset	236
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	237 OCTAVE_API void do_normal_distribution (void);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	238
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	239 OCTAVE_API 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
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	241 OCTAVE_API 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
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	243 OCTAVE_API 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
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	248 template <typename T> OCTAVE_API T uniform (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	249
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	250 template <typename T> OCTAVE_API T normal (void);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	251
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	252 template <typename T> OCTAVE_API T exponential (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	253
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	254 template <typename T> OCTAVE_API T poisson (T a);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	255
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	256 template <typename T> OCTAVE_API 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.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	259 template <typename T> OCTAVE_API 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.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	262 template <typename T> OCTAVE_API Array<T>
5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	263 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	264
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	265 // 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	266 // filled in column major order.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	267 OCTAVE_API 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	268
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	269 // 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	270 // filled in column major order.
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	271 OCTAVE_API FloatNDArray
5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	272 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	273
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	274 // Some helper functions.
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	275
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	276 OCTAVE_API void initialize_ranlib_generators (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	277
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	278 OCTAVE_API void initialize_mersenne_twister (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	279
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	280 OCTAVE_API uint32NDArray get_internal_state (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	281
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	282 OCTAVE_API void save_state (void);
7537 a2950622f070 make octave_rand a proper singleton class John W. Eaton <jwe@octave.org> parents: 7533 diff changeset	283
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	284 OCTAVE_API 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	285
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	286 OCTAVE_API 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	287
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	288 OCTAVE_API 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	289
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	290 OCTAVE_API 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	291
29228 5c14f81e0937 Set API tags in files in liboctave/numeric (patch #8919). Markus Mützel <markus.muetzel@gmx.de> parents: 27923 diff changeset	292 OCTAVE_API void fill (octave_idx_type len, float *v, float a);
25433 49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	293 };
49e0447413ad use templates and move rand functions inside octave namespace John W. Eaton <jwe@octave.org> parents: 25054 diff changeset	294 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14138 diff changeset	295
4308 b738d1a02adb [project @ 2003-01-24 19:37:12 by jwe] jwe parents: diff changeset	296 #endif

Mercurial > octave

annotate liboctave/numeric/oct-rand.h @ 30564:796f54d4ddbf stable