Mercurial > octave

annotate libinterp/corefcn/rand.cc @ 21234:20a824cd1d9e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
maint: Merge stable to default.
author Rik <rik@octave.org>
date Tue, 09 Feb 2016 10:35:28 -0800
parents fcac5dbbf9ed 6b0ded11d708
children 40de9f8f23a6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
1
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
2 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
3
19697
4197fc428c7d maint: Update copyright notices for 2015.
John W. Eaton <jwe@octave.org>
parents: 19040
diff changeset
4 Copyright (C) 1996-2015 John W. Eaton
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
5 Copyright (C) 2009 VZLU Prague
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
6
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
7 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
8
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
9 Octave is free software; you can redistribute it and/or modify it
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
10 under the terms of the GNU General Public License as published by the
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
11 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
12 option) any later version.
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
13
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
14 Octave is distributed in the hope that it will be useful, but WITHOUT
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
17 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
18
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
19 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: 7001
diff changeset
20 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 7001
diff changeset
21 <http://www.gnu.org/licenses/>.
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
22
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
23 */
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
24
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
25 #ifdef HAVE_CONFIG_H
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21170
diff changeset
26 # include <config.h>
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
27 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
28
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
29 #include <ctime>
13727
478efc95cb7a Test unordered_map header location and namespace.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13255
diff changeset
30 #if defined (HAVE_UNORDERED_MAP)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21170
diff changeset
31 # include <unordered_map>
13727
478efc95cb7a Test unordered_map header location and namespace.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13255
diff changeset
32 #elif defined (HAVE_TR1_UNORDERED_MAP)
21200
fcac5dbbf9ed maint: Indent #ifdef blocks in libinterp.
Rik <rik@octave.org>
parents: 21170
diff changeset
33 # include <tr1/unordered_map>
13727
478efc95cb7a Test unordered_map header location and namespace.
Michael Goffioul <michael.goffioul@gmail.com>
parents: 13255
diff changeset
34 #endif
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
35 #include <string>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
36
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
37 #include "f77-fcn.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
38 #include "lo-mappers.h"
4307
fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe]
jwe
parents: 4153
diff changeset
39 #include "oct-rand.h"
4153
6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe]
jwe
parents: 3887
diff changeset
40 #include "quit.h"
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
41
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
42 #include "defun.h"
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
43 #include "error.h"
21100
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents: 21041
diff changeset
44 #include "errwarn.h"
20940
48b2ad5ee801 maint: Rename oct-obj.[cc|h] to ovl.[cc|h] for clarity.
Rik <rik@octave.org>
parents: 20894
diff changeset
45 #include "ovl.h"
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
46 #include "unwind-prot.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
47 #include "utils.h"
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
48 #include "ov-re-mat.h"
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
49
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
50 /*
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
51 %!shared __random_statistical_tests__
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
52 %! ## Flag whether the statistical tests should be run in "make check" or not
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
53 %! __random_statistical_tests__ = 0;
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
54 */
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
55
4307
fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe]
jwe
parents: 4153
diff changeset
56 static octave_value
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
57 do_rand (const octave_value_list& args, int nargin, const char *fcn,
10782
d1f920d1ce0c simplify code in rand.cc
Jaroslav Hajek <highegg@gmail.com>
parents: 10709
diff changeset
58 const std::string& distribution, bool additional_arg = false)
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
59 {
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
60 NDArray a;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
61 int idx = 0;
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
62 bool is_single = false;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
63
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14706
diff changeset
64 if (nargin > 0 && args(nargin-1).is_string ())
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
65 {
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
66 std::string s_arg = args(nargin-1).string_value ();
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
67
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
68 if (s_arg == "single")
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
69 {
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
70 is_single = true;
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
71 nargin--;
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
72 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
73 else if (s_arg == "double")
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
74 nargin--;
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
75 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
76
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
77 if (additional_arg)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
78 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
79 if (nargin == 0)
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20801
diff changeset
80 error ("%s: at least one argument is required", fcn);
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14706
diff changeset
81 else if (args(0).is_string ())
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
82 additional_arg = false;
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
83 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
84 {
20711
7b608fadc663 Make error messages more specific about the variable and problem encountered.
Rik <rik@octave.org>
parents: 20704
diff changeset
85 a = args(0).xarray_value ("%s: dimension must be a scalar integer", fcn);
20704
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20687
diff changeset
86
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
87 idx++;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
88 nargin--;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
89 }
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
90 }
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
91
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
92 octave_value retval;
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
93 dim_vector dims;
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
94
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
95 unwind_protect frame;
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
96 // Restore current distribution on any exit.
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
97 frame.add_fcn (octave_rand::distribution,
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
98 octave_rand::distribution ());
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
99
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
100 octave_rand::distribution (distribution);
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
101
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
102 switch (nargin)
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
103 {
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
104 case 0:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
105 {
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
106 if (additional_arg)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
107 dims = a.dims ();
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
108 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
109 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
110 dims.resize (2);
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
111
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
112 dims(0) = 1;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
113 dims(1) = 1;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
114 }
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
115
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
116 goto gen_matrix;
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
117 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
118 break;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
119
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
120 case 1:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
121 {
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
122 octave_value tmp = args(idx);
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
123
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
124 if (tmp.is_string ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
125 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
126 std::string s_arg = tmp.string_value ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
127
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
128 if (s_arg == "dist")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
129 retval = octave_rand::distribution ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
130 else if (s_arg == "seed")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
131 retval = octave_rand::seed ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
132 else if (s_arg == "state" || s_arg == "twister")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
133 retval = octave_rand::state (fcn);
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
134 else if (s_arg == "uniform")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
135 octave_rand::uniform_distribution ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
136 else if (s_arg == "normal")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
137 octave_rand::normal_distribution ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
138 else if (s_arg == "exponential")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
139 octave_rand::exponential_distribution ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
140 else if (s_arg == "poisson")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
141 octave_rand::poisson_distribution ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
142 else if (s_arg == "gamma")
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
143 octave_rand::gamma_distribution ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
144 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
145 error ("%s: unrecognized string argument", fcn);
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
146 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
147 else if (tmp.is_scalar_type ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
148 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
149 double dval = tmp.double_value ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
150
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
151 if (xisnan (dval))
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20801
diff changeset
152 error ("%s: NaN is invalid matrix dimension", fcn);
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
153
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
154 dims.resize (2);
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
155
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
156 dims(0) = NINTbig (tmp.double_value ());
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
157 dims(1) = NINTbig (tmp.double_value ());
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
158
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
159 goto gen_matrix;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
160 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
161 else if (tmp.is_range ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
162 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
163 Range r = tmp.range_value ();
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
164
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
165 if (! r.all_elements_are_ints ())
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
166 error ("%s: all elements of range must be integers", fcn);
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
167
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
168 octave_idx_type n = r.numel ();
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
169
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
170 dims.resize (n);
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
171
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
172 octave_idx_type base = NINTbig (r.base ());
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
173 octave_idx_type incr = NINTbig (r.inc ());
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
174
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
175 for (octave_idx_type i = 0; i < n; i++)
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
176 {
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
177 // Negative dimensions treated as zero for Matlab compatibility
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
178 dims(i) = base >= 0 ? base : 0;
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
179 base += incr;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
180 }
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
181
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
182 goto gen_matrix;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
183 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
184 else if (tmp.is_matrix_type ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
185 {
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
186 Array<int> iv;
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
187
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
188 try
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
189 {
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
190 iv = tmp.int_vector_value (true);
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
191 }
20785
b6f2909e7f94 always throw exception after debugging with debug_on_error
John W. Eaton <jwe@octave.org>
parents: 20756
diff changeset
192 catch (octave_execution_exception& e)
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
193 {
20756
200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks
John W. Eaton <jwe@octave.org>
parents: 20743
diff changeset
194 error (e, "%s: dimensions must be a scalar or array of integers", fcn);
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
195 }
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
196
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
197 octave_idx_type len = iv.numel ();
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
198
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
199 dims.resize (len);
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
200
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
201 for (octave_idx_type i = 0; i < len; i++)
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
202 {
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
203 // Negative dimensions treated as zero for Matlab compatibility
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
204 octave_idx_type elt = iv(i);
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
205 dims(i) = elt >=0 ? elt : 0;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
206 }
20743
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
207
b6408331bfa2 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20711
diff changeset
208 goto gen_matrix;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
209 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
210 else
21129
228b65504557 maint: Eliminate useless statements after err_XXX.
Rik <rik@octave.org>
parents: 21127
diff changeset
211 err_wrong_type_arg ("rand", tmp);
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
212 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
213 break;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
214
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
215 default:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
216 {
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
217 octave_value tmp = args(idx);
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
218
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
219 if (nargin == 2 && tmp.is_string ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
220 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
221 std::string ts = tmp.string_value ();
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents: 4665
diff changeset
222
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
223 if (ts == "seed")
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
224 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
225 if (args(idx+1).is_real_scalar ())
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
226 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
227 double d = args(idx+1).double_value ();
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
228
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
229 octave_rand::seed (d);
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
230 }
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
231 else if (args(idx+1).is_string ()
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14706
diff changeset
232 && args(idx+1).string_value () == "reset")
10709
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
233 octave_rand::reset ();
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
234 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
235 error ("%s: seed must be a real scalar", fcn);
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
236 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
237 else if (ts == "state" || ts == "twister")
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
238 {
10709
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
239 if (args(idx+1).is_string ()
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14706
diff changeset
240 && args(idx+1).string_value () == "reset")
10709
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
241 octave_rand::reset (fcn);
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
242 else
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
243 {
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
244 ColumnVector s =
10709
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
245 ColumnVector (args(idx+1).vector_value(false, true));
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
246
20678
4b00afb5e9c3 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20535
diff changeset
247 octave_rand::state (s, fcn);
10709
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
248 }
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
249 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
250 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
251 error ("%s: unrecognized string argument", fcn);
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
252 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
253 else
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
254 {
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
255 dims.resize (nargin);
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
256
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
257 for (int i = 0; i < nargin; i++)
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
258 {
21041
63374982750b Usage of corresponding value extractor for octave_idx_type. Improves support
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 20940
diff changeset
259 octave_idx_type elt =
63374982750b Usage of corresponding value extractor for octave_idx_type. Improves support
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 20940
diff changeset
260 args(idx+i).xidx_type_value (
63374982750b Usage of corresponding value extractor for octave_idx_type. Improves support
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 20940
diff changeset
261 "%s: dimension must be a scalar or array of integers",
63374982750b Usage of corresponding value extractor for octave_idx_type. Improves support
Kai T. Ohlhus <k.ohlhus@gmail.com>
parents: 20940
diff changeset
262 fcn);
20704
571508c1ed06 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20687
diff changeset
263
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
264 // Negative dimensions treated as zero for Matlab compatibility
12905
f7a8d1dafda3 Let rand accept negative dimensions (bug #33301)
Jordi Gutiérrez Hermoso <jordigh@gmail.com>
parents: 12639
diff changeset
265 dims(i) = elt >= 0 ? elt : 0;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
266 }
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
267
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
268 goto gen_matrix;
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
269 }
4543
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
270 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe]
jwe
parents: 4307
diff changeset
271 break;
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
272 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
273
21170
1edaf1ee65eb maint: Replace some uses of goto in libinterp.
Rik <rik@octave.org>
parents: 21129
diff changeset
274 // No "goto gen_matrix" in code path. Must be done processing.
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
275 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
276
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
277 gen_matrix:
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
278
5355
cf44c749ba52 [project @ 2005-05-18 11:43:37 by jwe]
jwe
parents: 5307
diff changeset
279 dims.chop_trailing_singletons ();
cf44c749ba52 [project @ 2005-05-18 11:43:37 by jwe]
jwe
parents: 5307
diff changeset
280
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
281 if (is_single)
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
282 {
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
283 if (additional_arg)
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
284 {
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20228
diff changeset
285 if (a.numel () == 1)
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
286 return octave_rand::float_nd_array (dims, a(0));
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
287 else
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
288 {
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14706
diff changeset
289 if (a.dims () != dims)
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20801
diff changeset
290 error ("%s: mismatch in argument size", fcn);
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20801
diff changeset
291
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20228
diff changeset
292 octave_idx_type len = a.numel ();
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
293 FloatNDArray m (dims);
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
294 float *v = m.fortran_vec ();
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
295
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
296 for (octave_idx_type i = 0; i < len; i++)
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
297 v[i] = octave_rand::float_scalar (a(i));
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
298
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
299 return m;
10154
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
300 }
40dfc0c99116 DLD-FUNCTIONS/*.cc: untabify
John W. Eaton <jwe@octave.org>
parents: 10066
diff changeset
301 }
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
302 else
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
303 return octave_rand::float_nd_array (dims);
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
304 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
305 else
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
306 {
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
307 if (additional_arg)
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
308 {
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20228
diff changeset
309 if (a.numel () == 1)
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
310 return octave_rand::nd_array (dims, a(0));
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
311 else
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
312 {
14846
460a3c6d8bf1 maint: Use Octave coding convention for cuddled parenthis in function calls with empty argument lists.
Rik <octave@nomad.inbox5.com>
parents: 14706
diff changeset
313 if (a.dims () != dims)
20831
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20801
diff changeset
314 error ("%s: mismatch in argument size", fcn);
35241c4b696c eliminate return statements after calls to error
John W. Eaton <jwe@octave.org>
parents: 20801
diff changeset
315
20232
a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel().
Carnë Draug <carandraug@octave.org>
parents: 20228
diff changeset
316 octave_idx_type len = a.numel ();
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
317 NDArray m (dims);
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
318 double *v = m.fortran_vec ();
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
319
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
320 for (octave_idx_type i = 0; i < len; i++)
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
321 v[i] = octave_rand::scalar (a(i));
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
322
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
323 return m;
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
324 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
325 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
326 else
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
327 return octave_rand::nd_array (dims);
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
328 }
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
329 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
330
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
331 DEFUN (rand, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
332 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
333 @deftypefn {} {} rand (@var{n})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
334 @deftypefnx {} {} rand (@var{m}, @var{n}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
335 @deftypefnx {} {} rand ([@var{m} @var{n} @dots{}])\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
336 @deftypefnx {} {@var{v} =} rand (\"state\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
337 @deftypefnx {} {} rand (\"state\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
338 @deftypefnx {} {} rand (\"state\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
339 @deftypefnx {} {@var{v} =} rand (\"seed\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
340 @deftypefnx {} {} rand (\"seed\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
341 @deftypefnx {} {} rand (\"seed\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
342 @deftypefnx {} {} rand (@dots{}, \"single\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
343 @deftypefnx {} {} rand (@dots{}, \"double\")\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
344 Return a matrix with random elements uniformly distributed on the\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
345 interval (0, 1).\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
346 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
347 The arguments are handled the same as the arguments for @code{eye}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
348 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
349 You can query the state of the random number generator using the form\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
350 \n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
351 @example\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
352 v = rand (\"state\")\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
353 @end example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
354 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
355 This returns a column vector @var{v} of length 625. Later, you can restore\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
356 the random number generator to the state @var{v} using the form\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
357 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
358 @example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
359 rand (\"state\", v)\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
360 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
361 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
362 @noindent\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
363 You may also initialize the state vector from an arbitrary vector of length\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
364 @leq{} 625 for @var{v}. This new state will be a hash based on the value of\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
365 @var{v}, not @var{v} itself.\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
366 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
367 By default, the generator is initialized from @code{/dev/urandom} if it is\n\
12639
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents: 11586
diff changeset
368 available, otherwise from CPU time, wall clock time, and the current\n\
14620
cd375519eab0 doc: Periodic grammar check of documentation
Rik <octave@nomad.inbox5.com>
parents: 14610
diff changeset
369 fraction of a second. Note that this differs from @sc{matlab}, which\n\
14610
41d7e23f5734 Document rand's seed difference from Matlab
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14501
diff changeset
370 always initializes the state to the same state at startup. To obtain\n\
14620
cd375519eab0 doc: Periodic grammar check of documentation
Rik <octave@nomad.inbox5.com>
parents: 14610
diff changeset
371 behavior comparable to @sc{matlab}, initialize with a deterministic state\n\
14610
41d7e23f5734 Document rand's seed difference from Matlab
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14501
diff changeset
372 vector in Octave's startup files (@pxref{Startup Files}).\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
373 \n\
8325
b93ac0586e4b spelling corrections
Brian Gough<bjg@network-theory.co.uk>
parents: 7780
diff changeset
374 To compute the pseudo-random sequence, @code{rand} uses the Mersenne\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
375 Twister with a period of @math{2^{19937}-1}\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
376 (See @nospell{M. Matsumoto and T. Nishimura},\n\
12639
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents: 11586
diff changeset
377 @cite{Mersenne Twister: A 623-dimensionally equidistributed uniform\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
378 pseudorandom number generator},\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
379 ACM Trans. on Modeling and Computer Simulation Vol. 8, No. 1, pp. 3--30,\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
380 January 1998,\n\
7171
9bc096bc59d4 [project @ 2007-11-13 18:02:51 by jwe]
jwe
parents: 7096
diff changeset
381 @url{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html}).\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
382 Do @strong{not} use for cryptography without securely hashing several\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
383 returned values together, otherwise the generator state can be learned after\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
384 reading 624 consecutive values.\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
385 \n\
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7029
diff changeset
386 Older versions of Octave used a different random number generator.\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
387 The new generator is used by default as it is significantly faster than the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
388 old generator, and produces random numbers with a significantly longer cycle\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
389 time. However, in some circumstances it might be desirable to obtain the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
390 same random sequences as produced by the old generators. To do this the\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
391 keyword @qcode{\"seed\"} is used to specify that the old generators should\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
392 be used, as in\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
393 \n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
394 @example\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
395 rand (\"seed\", val)\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
396 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
397 \n\
10846
a4f482e66b65 Grammarcheck more of the documentation.
Rik <octave@nomad.inbox5.com>
parents: 10840
diff changeset
398 @noindent\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 9041
diff changeset
399 which sets the seed of the generator to @var{val}. The seed of the\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
400 generator can be queried with\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
401 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
402 @example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
403 s = rand (\"seed\")\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
404 @end example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
405 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
406 However, it should be noted that querying the seed will not cause\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
407 @code{rand} to use the old generators, only setting the seed will. To cause\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
408 @code{rand} to once again use the new generators, the keyword\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
409 @qcode{\"state\"} should be used to reset the state of the @code{rand}.\n\
10709
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118)
David Bateman <dbateman@free.fr>
parents: 10687
diff changeset
410 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
411 The state or seed of the generator can be reset to a new random value using\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
412 the @qcode{\"reset\"} keyword.\n\
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
413 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
414 The class of the value returned can be controlled by a trailing\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
415 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
416 classes.\n\
5798
7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe]
jwe
parents: 5782
diff changeset
417 @seealso{randn, rande, randg, randp}\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
418 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
419 {
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
420 return do_rand (args, args.length (), "rand", "uniform");
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
421 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
422
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
423 // FIXME: The old generator (selected when "seed" is set) will not
8871
fb1c929dbbb7 tests vs. 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 8828
diff changeset
424 // work properly if compiled to use 64-bit integers.
fb1c929dbbb7 tests vs. 64-bit indexing
John W. Eaton <jwe@octave.org>
parents: 8828
diff changeset
425
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
426 /*
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
427 %!test # "state" can be a scalar
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
428 %! rand ("state", 12); x = rand (1,4);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
429 %! rand ("state", 12); y = rand (1,4);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
430 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
431 %!test # "state" can be a vector
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
432 %! rand ("state", [12,13]); x = rand (1,4);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
433 %! rand ("state", [12;13]); y = rand (1,4);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
434 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
435 %!test # querying "state" doesn't disturb sequence
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
436 %! rand ("state", 12); rand (1,2); x = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
437 %! rand ("state", 12); rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
438 %! s = rand ("state"); y = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
439 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
440 %! rand ("state", s); z = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
441 %! assert (x, z);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
442 %!test # "seed" must be a scalar
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
443 %! rand ("seed", 12); x = rand (1,4);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
444 %! rand ("seed", 12); y = rand (1,4);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
445 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
446 %!error <seed must be a real scalar> rand ("seed", [12,13])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
447 %!test # querying "seed" returns a value which can be used later
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
448 %! s = rand ("seed"); x = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
449 %! rand ("seed", s); y = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
450 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
451 %!test # querying "seed" doesn't disturb sequence
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
452 %! rand ("seed", 12); rand (1,2); x = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
453 %! rand ("seed", 12); rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
454 %! s = rand ("seed"); y = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
455 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
456 %! rand ("seed", s); z = rand (1,2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
457 %! assert (x, z);
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
458 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
459
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
460 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
461 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
462 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
463 %! rand ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
464 %! assert (rand (1,6), [0.1343642441124013 0.8474337369372327 0.763774618976614 0.2550690257394218 0.495435087091941 0.4494910647887382], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
465 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
466 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
467 %! rand ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
468 %! assert (rand (1,6), [0.8668024251237512 0.9126510815694928 0.09366085007786751 0.1664607301354408 0.7408077004365623 0.7615650338120759], 1e-6);
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
469 %!test
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
470 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
471 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
472 %! rand ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
473 %! x = rand (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
474 %! assert (max (x) < 1); #*** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
475 %! assert (min (x) > 0); #*** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
476 %! assert (mean (x), 0.5, 0.0024);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
477 %! assert (var (x), 1/48, 0.0632);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
478 %! assert (skewness (x), 0, 0.012);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
479 %! assert (kurtosis (x), -6/5, 0.0094);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
480 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
481 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
482 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
483 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
484 %! rand ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
485 %! x = rand (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
486 %! assert (max (x) < 1); #*** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
487 %! assert (min (x) > 0); #*** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
488 %! assert (mean (x), 0.5, 0.0024);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
489 %! assert (var (x), 1/48, 0.0632);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
490 %! assert (skewness (x), 0, 0.012);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
491 %! assert (kurtosis (x), -6/5, 0.0094);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
492 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
493 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
494
17258
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
495 /*
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
496 %!# Test out-of-range values as rand() seeds. See oct-rand.cc: double2uint32().
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
497 %!function v = __rand_sample__ (initval)
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
498 %! rand ("state", initval);
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
499 %! v = rand (1, 6);
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
500 %!endfunction
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
501 %!
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
502 %!assert (__rand_sample__ (0), __rand_sample__ (2^32))
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
503 %!assert (__rand_sample__ (-2), __rand_sample__ (2^32-2))
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
504 %!assert (__rand_sample__ (Inf), __rand_sample__ (NaN))
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
505 %!assert (! isequal (__rand_sample__ (-1), __rand_sample__ (-2)))
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
506 */
213ee68b59da Handle out-of-range values consistently when initializing random number generator.
Philipp Kutin <philipp.kutin@gmail.com>
parents: 15195
diff changeset
507
4307
fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe]
jwe
parents: 4153
diff changeset
508 static std::string current_distribution = octave_rand::distribution ();
fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe]
jwe
parents: 4153
diff changeset
509
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
510 DEFUN (randn, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
511 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
512 @deftypefn {} {} randn (@var{n})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
513 @deftypefnx {} {} randn (@var{m}, @var{n}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
514 @deftypefnx {} {} randn ([@var{m} @var{n} @dots{}])\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
515 @deftypefnx {} {@var{v} =} randn (\"state\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
516 @deftypefnx {} {} randn (\"state\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
517 @deftypefnx {} {} randn (\"state\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
518 @deftypefnx {} {@var{v} =} randn (\"seed\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
519 @deftypefnx {} {} randn (\"seed\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
520 @deftypefnx {} {} randn (\"seed\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
521 @deftypefnx {} {} randn (@dots{}, \"single\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
522 @deftypefnx {} {} randn (@dots{}, \"double\")\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
523 Return a matrix with normally distributed random elements having zero mean\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
524 and variance one.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
525 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
526 The arguments are handled the same as the arguments for @code{rand}.\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
527 \n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
528 By default, @code{randn} uses the @nospell{Marsaglia and Tsang}\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
529 ``Ziggurat technique'' to transform from a uniform to a normal distribution.\n\
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10787
diff changeset
530 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
531 The class of the value returned can be controlled by a trailing\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
532 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
533 classes.\n\
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
534 \n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
535 Reference: @nospell{G. Marsaglia and W.W. Tsang},\n\
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10787
diff changeset
536 @cite{Ziggurat Method for Generating Random Variables},\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
537 J. Statistical Software, vol 5, 2000,\n\
18679
a142f35f3cb6 doc: Fix unbalanced parentheses in documentation.
Rik <rik@octave.org>
parents: 18574
diff changeset
538 @url{http://www.jstatsoft.org/v05/i08/}\n\
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
539 \n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
540 @seealso{rand, rande, randg, randp}\n\
3369
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe]
jwe
parents: 3325
diff changeset
541 @end deftypefn")
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
542 {
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
543 return do_rand (args, args.length (), "randn", "normal");
2928
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
544 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
545
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe]
jwe
parents:
diff changeset
546 /*
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
547 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
548 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
549 %! randn ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
550 %! assert (randn (1, 6), [-2.666521678978671 -0.7381719971724564 1.507903992673601 0.6019427189162239 -0.450661261143348 -0.7054431351574116], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
551 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
552 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
553 %! randn ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
554 %! assert (randn (1, 6), [-1.039402365684509 -1.25938892364502 0.1968704611063004 0.3874166905879974 -0.5976632833480835 -0.6615074276924133], 1e-6);
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
555 %!test
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
556 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
557 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
558 %! randn ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
559 %! x = randn (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
560 %! assert (mean (x), 0, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
561 %! assert (var (x), 1, 0.02);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
562 %! assert (skewness (x), 0, 0.02);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
563 %! assert (kurtosis (x), 0, 0.04);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
564 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
565 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
566 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
567 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
568 %! randn ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
569 %! x = randn (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
570 %! assert (mean (x), 0, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
571 %! assert (var (x), 1, 0.02);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
572 %! assert (skewness (x), 0, 0.02);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
573 %! assert (kurtosis (x), 0, 0.04);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
574 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
575 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
576
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
577 DEFUN (rande, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
578 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
579 @deftypefn {} {} rande (@var{n})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
580 @deftypefnx {} {} rande (@var{m}, @var{n}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
581 @deftypefnx {} {} rande ([@var{m} @var{n} @dots{}])\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
582 @deftypefnx {} {@var{v} =} rande (\"state\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
583 @deftypefnx {} {} rande (\"state\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
584 @deftypefnx {} {} rande (\"state\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
585 @deftypefnx {} {@var{v} =} rande (\"seed\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
586 @deftypefnx {} {} rande (\"seed\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
587 @deftypefnx {} {} rande (\"seed\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
588 @deftypefnx {} {} rande (@dots{}, \"single\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
589 @deftypefnx {} {} rande (@dots{}, \"double\")\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
590 Return a matrix with exponentially distributed random elements.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
591 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
592 The arguments are handled the same as the arguments for @code{rand}.\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
593 \n\
21233
6b0ded11d708 Fix cut/paste error in rande documentation (bug #47097).
Rik <rik@octave.org>
parents: 20172
diff changeset
594 By default, @code{rande} uses the @nospell{Marsaglia and Tsang}\n\
6b0ded11d708 Fix cut/paste error in rande documentation (bug #47097).
Rik <rik@octave.org>
parents: 20172
diff changeset
595 ``Ziggurat technique'' to transform from a uniform to an exponential\n\
6b0ded11d708 Fix cut/paste error in rande documentation (bug #47097).
Rik <rik@octave.org>
parents: 20172
diff changeset
596 distribution.\n\
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10787
diff changeset
597 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
598 The class of the value returned can be controlled by a trailing\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
599 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
600 classes.\n\
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
601 \n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
602 Reference: @nospell{G. Marsaglia and W.W. Tsang},\n\
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10787
diff changeset
603 @cite{Ziggurat Method for Generating Random Variables},\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
604 J. Statistical Software, vol 5, 2000,\n\
18679
a142f35f3cb6 doc: Fix unbalanced parentheses in documentation.
Rik <rik@octave.org>
parents: 18574
diff changeset
605 @url{http://www.jstatsoft.org/v05/i08/}\n\
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10787
diff changeset
606 \n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
607 @seealso{rand, randn, randg, randp}\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
608 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
609 {
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
610 return do_rand (args, args.length (), "rande", "exponential");
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
611 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
612
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
613 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
614 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
615 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
616 %! rande ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
617 %! assert (rande (1, 6), [3.602973885835625 0.1386190677555021 0.6743112889616958 0.4512830847258422 0.7255744741233175 0.3415969205292291], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
618 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
619 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
620 %! rande ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
621 %! assert (rande (1, 6), [0.06492075175653866 1.717980206012726 0.4816154008731246 0.5231300676241517 0.103910739364359 1.668931916356087], 1e-6);
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
622 %!test
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
623 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
624 %! ## statistical tests may fail occasionally
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
625 %! rande ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
626 %! x = rande (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
627 %! assert (min (x) > 0); # *** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
628 %! assert (mean (x), 1, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
629 %! assert (var (x), 1, 0.03);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
630 %! assert (skewness (x), 2, 0.06);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
631 %! assert (kurtosis (x), 6, 0.7);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
632 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
633 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
634 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
635 %! ## statistical tests may fail occasionally
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
636 %! rande ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
637 %! x = rande (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
638 %! assert (min (x)>0); # *** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
639 %! assert (mean (x), 1, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
640 %! assert (var (x), 1, 0.03);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
641 %! assert (skewness (x), 2, 0.06);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
642 %! assert (kurtosis (x), 6, 0.7);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
643 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
644 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
645
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
646 DEFUN (randg, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
647 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
648 @deftypefn {} {} randg (@var{n})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
649 @deftypefnx {} {} randg (@var{m}, @var{n}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
650 @deftypefnx {} {} randg ([@var{m} @var{n} @dots{}])\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
651 @deftypefnx {} {@var{v} =} randg (\"state\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
652 @deftypefnx {} {} randg (\"state\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
653 @deftypefnx {} {} randg (\"state\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
654 @deftypefnx {} {@var{v} =} randg (\"seed\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
655 @deftypefnx {} {} randg (\"seed\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
656 @deftypefnx {} {} randg (\"seed\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
657 @deftypefnx {} {} randg (@dots{}, \"single\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
658 @deftypefnx {} {} randg (@dots{}, \"double\")\n\
14854
5ae9f0f77635 maint: Use Octave coding conventions for coddling parenthis is DLD-FUNCTIONS directory
Rik <octave@nomad.inbox5.com>
parents: 14853
diff changeset
659 Return a matrix with @code{gamma (@var{a},1)} distributed random elements.\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
660 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
661 The arguments are handled the same as the arguments for @code{rand}, except\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
662 for the argument @var{a}.\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
663 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
664 This can be used to generate many distributions:\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
665 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
666 @table @asis\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
667 @item @code{gamma (a, b)} for @code{a > -1}, @code{b > 0}\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
668 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
669 @example\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
670 r = b * randg (a)\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
671 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
672 \n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
673 @item @code{beta (a, b)} for @code{a > -1}, @code{b > -1}\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
674 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
675 @example\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 9041
diff changeset
676 @group\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
677 r1 = randg (a, 1)\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
678 r = r1 / (r1 + randg (b, 1))\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 9041
diff changeset
679 @end group\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
680 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
681 \n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
682 @item @code{Erlang (a, n)}\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
683 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
684 @example\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
685 r = a * randg (n)\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
686 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
687 \n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
688 @item @code{chisq (df)} for @code{df > 0}\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
689 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
690 @example\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
691 r = 2 * randg (df / 2)\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
692 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
693 \n\
12639
4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter.
Rik <octave@nomad.inbox5.com>
parents: 11586
diff changeset
694 @item @code{t (df)} for @code{0 < df < inf} (use randn if df is infinite)\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
695 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
696 @example\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
697 r = randn () / sqrt (2 * randg (df / 2) / df)\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
698 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
699 \n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
700 @item @code{F (n1, n2)} for @code{0 < n1}, @code{0 < n2}\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
701 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
702 @example\n\
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7029
diff changeset
703 @group\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7029
diff changeset
704 ## r1 equals 1 if n1 is infinite\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7029
diff changeset
705 r1 = 2 * randg (n1 / 2) / n1\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7029
diff changeset
706 ## r2 equals 1 if n2 is infinite\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7029
diff changeset
707 r2 = 2 * randg (n2 / 2) / n2\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
708 r = r1 / r2\n\n\
7096
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe]
jwe
parents: 7029
diff changeset
709 @end group\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
710 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
711 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
712 @item negative @code{binomial (n, p)} for @code{n > 0}, @code{0 < p <= 1}\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
713 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
714 @example\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
715 r = randp ((1 - p) / p * randg (n))\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
716 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
717 \n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
718 @item non-central @code{chisq (df, L)}, for @code{df >= 0} and @code{L > 0}\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
719 (use chisq if @code{L = 0})\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
720 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
721 @example\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 9041
diff changeset
722 @group\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
723 r = randp (L / 2)\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
724 r(r > 0) = 2 * randg (r(r > 0))\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
725 r(df > 0) += 2 * randg (df(df > 0)/2)\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 9041
diff changeset
726 @end group\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
727 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
728 \n\
9041
853f96e8008f Cleanup documentation file matrix.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
729 @item @code{Dirichlet (a1, @dots{} ak)}\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
730 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
731 @example\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 9041
diff changeset
732 @group\n\
9041
853f96e8008f Cleanup documentation file matrix.texi
Rik <rdrider0-list@yahoo.com>
parents: 8920
diff changeset
733 r = (randg (a1), @dots{}, randg (ak))\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
734 r = r / sum (r)\n\
9064
7c02ec148a3c Check grammar on all .cc files
Rik <rdrider0-list@yahoo.com>
parents: 9041
diff changeset
735 @end group\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
736 @end example\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
737 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
738 @end table\n\
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
739 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
740 The class of the value returned can be controlled by a trailing\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
741 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
742 classes.\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
743 @seealso{rand, randn, rande, randp}\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
744 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
745 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
746 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
747
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
748 if (nargin < 1)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
749 error ("randg: insufficient arguments");
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
750
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
751 return do_rand (args, nargin, "randg", "gamma", true);
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
752 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
753
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
754 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
755 %!test
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
756 %! randg ("state", 12)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
757 %! assert (randg ([-inf, -1, 0, inf, nan]), [nan, nan, nan, nan, nan]); # *** Please report
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
758
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
759 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
760 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
761 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
762 %! assert (randg (0.1, 1, 6), [0.0103951513331241 8.335671459898252e-05 0.00138691397249762 0.000587308416993855 0.495590518784736 2.3921917414795e-12], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
763 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
764 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
765 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
766 %! assert (randg (0.95, 1, 6), [3.099382433255327 0.3974529788871218 0.644367450750855 1.143261091802246 1.964111762696822 0.04011915547957939], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
767 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
768 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
769 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
770 %! assert (randg (1, 1, 6), [0.2273389379645993 1.288822625058359 0.2406335209340746 1.218869553370733 1.024649860162554 0.09631230343599533], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
771 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
772 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
773 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
774 %! assert (randg (10, 1, 6), [3.520369644331133 15.15369864472106 8.332112081991205 8.406211067432674 11.81193475187611 10.88792728177059], 1e-5);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
775 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
776 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
777 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
778 %! assert (randg (100, 1, 6), [75.34570255262264 115.4911985594699 95.23493031356388 95.48926019250911 106.2397448229803 103.4813150404118], 1e-4);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
779 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
780 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
781 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
782 %! assert (randg (0.1, 1, 6), [0.07144210487604141 0.460641473531723 0.4749028384685516 0.06823389977216721 0.000293838675133884 1.802567535340305e-12], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
783 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
784 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
785 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
786 %! assert (randg (0.95, 1, 6), [1.664905071258545 1.879976987838745 1.905677795410156 0.9948706030845642 0.5606933236122131 0.0766092911362648], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
787 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
788 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
789 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
790 %! assert (randg (1, 1, 6), [0.03512085229158401 0.6488978862762451 0.8114678859710693 0.1666885763406754 1.60791552066803 1.90356981754303], 1e-6);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
791 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
792 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
793 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
794 %! assert (randg (10, 1, 6), [6.566435813903809 10.11648464202881 10.73162078857422 7.747178077697754 6.278522491455078 6.240195751190186], 1e-5);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
795 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
796 %! ## Test fixed seed
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
797 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
798 %! assert (randg (100, 1, 6), [89.40208435058594 101.4734725952148 103.4020004272461 93.62763214111328 88.33104705810547 88.1871337890625], 1e-4);
18573
53ba52143af7 Fix dead assignment in oct-rand.cc do_float_scalar (bug #41827).
Branden Archer <b.m.archer4@gmail.com>
parents: 18436
diff changeset
799 %!test
53ba52143af7 Fix dead assignment in oct-rand.cc do_float_scalar (bug #41827).
Branden Archer <b.m.archer4@gmail.com>
parents: 18436
diff changeset
800 %! ## Test out-of-bounds values produce NaN w/old-style generators & floats
53ba52143af7 Fix dead assignment in oct-rand.cc do_float_scalar (bug #41827).
Branden Archer <b.m.archer4@gmail.com>
parents: 18436
diff changeset
801 %! randg ("seed", 1);
53ba52143af7 Fix dead assignment in oct-rand.cc do_float_scalar (bug #41827).
Branden Archer <b.m.archer4@gmail.com>
parents: 18436
diff changeset
802 %! result = randg ([-2 Inf], "single");
18574
756e906bdfda Fix %!test comparing NaN (single) to NaN (double) in cset 53ba52143af7.
Rik <rik@octave.org>
parents: 18573
diff changeset
803 %! assert (result, single ([NaN NaN]));
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
804
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
805 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
806 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
807 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
808 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
809 %! a = 0.1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
810 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
811 %! assert (mean (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
812 %! assert (var (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
813 %! assert (skewness (x), 2/sqrt (a), 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
814 %! assert (kurtosis (x), 6/a, 50);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
815 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
816 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
817 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
818 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
819 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
820 %! a = 0.95;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
821 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
822 %! assert (mean (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
823 %! assert (var (x), a, 0.04);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
824 %! assert (skewness (x), 2/sqrt (a), 0.2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
825 %! assert (kurtosis (x), 6/a, 2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
826 %! endif
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
827 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
828 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
829 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
830 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
831 %! a = 1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
832 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
833 %! assert (mean (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
834 %! assert (var (x), a, 0.04);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
835 %! assert (skewness (x), 2/sqrt (a), 0.2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
836 %! assert (kurtosis (x), 6/a, 2);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
837 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
838 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
839 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
840 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
841 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
842 %! a = 10;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
843 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
844 %! assert (mean (x), a, 0.1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
845 %! assert (var (x), a, 0.5);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
846 %! assert (skewness (x), 2/sqrt (a), 0.1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
847 %! assert (kurtosis (x), 6/a, 0.5);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
848 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
849 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
850 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
851 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
852 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
853 %! a = 100;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
854 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
855 %! assert (mean (x), a, 0.2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
856 %! assert (var (x), a, 2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
857 %! assert (skewness (x), 2/sqrt (a), 0.05);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
858 %! assert (kurtosis (x), 6/a, 0.2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
859 %! endif
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
860 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
861 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
862 %!assert (randg ([-inf, -1, 0, inf, nan]), [nan, nan, nan, nan, nan]) # *** Please report
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
863 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
864 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
865 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
866 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
867 %! a = 0.1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
868 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
869 %! assert (mean (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
870 %! assert (var (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
871 %! assert (skewness (x), 2/sqrt (a), 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
872 %! assert (kurtosis (x), 6/a, 50);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
873 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
874 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
875 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
876 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
877 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
878 %! a = 0.95;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
879 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
880 %! assert (mean (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
881 %! assert (var (x), a, 0.04);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
882 %! assert (skewness (x), 2/sqrt (a), 0.2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
883 %! assert (kurtosis (x), 6/a, 2);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
884 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
885 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
886 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
887 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
888 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
889 %! a = 1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
890 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
891 %! assert (mean (x), a, 0.01);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
892 %! assert (var (x), a, 0.04);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
893 %! assert (skewness (x), 2/sqrt (a), 0.2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
894 %! assert (kurtosis (x), 6/a, 2);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
895 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
896 %!test
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
897 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
898 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
899 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
900 %! a = 10;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
901 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
902 %! assert (mean (x), a, 0.1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
903 %! assert (var (x), a, 0.5);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
904 %! assert (skewness (x), 2/sqrt (a), 0.1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
905 %! assert (kurtosis (x), 6/a, 0.5);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
906 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
907 %!test
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
908 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
909 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
910 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
911 %! a = 100;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
912 %! x = randg (a, 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
913 %! assert (mean (x), a, 0.2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
914 %! assert (var (x), a, 2);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
915 %! assert (skewness (x), 2/sqrt (a), 0.05);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
916 %! assert (kurtosis (x), 6/a, 0.2);
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
917 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
918 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
919
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
920 DEFUN (randp, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
921 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
922 @deftypefn {} {} randp (@var{l}, @var{n})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
923 @deftypefnx {} {} randp (@var{l}, @var{m}, @var{n}, @dots{})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
924 @deftypefnx {} {} randp (@var{l}, [@var{m} @var{n} @dots{}])\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
925 @deftypefnx {} {@var{v} =} randp (\"state\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
926 @deftypefnx {} {} randp (\"state\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
927 @deftypefnx {} {} randp (\"state\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
928 @deftypefnx {} {@var{v} =} randp (\"seed\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
929 @deftypefnx {} {} randp (\"seed\", @var{v})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
930 @deftypefnx {} {} randp (\"seed\", \"reset\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
931 @deftypefnx {} {} randp (@dots{}, \"single\")\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
932 @deftypefnx {} {} randp (@dots{}, \"double\")\n\
10687
a8ce6bdecce5 Improve documentation strings.
Rik <octave@nomad.inbox5.com>
parents: 10155
diff changeset
933 Return a matrix with Poisson distributed random elements with mean value\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
934 parameter given by the first argument, @var{l}.\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
935 \n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
936 The arguments are handled the same as the arguments for @code{rand}, except\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
937 for the argument @var{l}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
938 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
939 Five different algorithms are used depending on the range of @var{l} and\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
940 whether or not @var{l} is a scalar or a matrix.\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
941 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
942 @table @asis\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
943 @item For scalar @var{l} @leq{} 12, use direct method.\n\
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
944 W.H. Press, et al., @cite{Numerical Recipes in C},\n\
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
945 Cambridge University Press, 1992.\n\
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
946 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
947 @item For scalar @var{l} > 12, use rejection method.[1]\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
948 W.H. Press, et al., @cite{Numerical Recipes in C},\n\
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
949 Cambridge University Press, 1992.\n\
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
950 \n\
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
951 @item For matrix @var{l} @leq{} 10, use inversion method.[2]\n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
952 @nospell{E. Stadlober, et al., WinRand source code}, available via FTP.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
953 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
954 @item For matrix @var{l} > 10, use patchwork rejection method.\n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
955 @nospell{E. Stadlober, et al., WinRand source code}, available via FTP, or\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
956 @nospell{H. Zechner}, @cite{Efficient sampling from continuous and discrete\n\
10791
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation
Rik <octave@nomad.inbox5.com>
parents: 10787
diff changeset
957 unimodal distributions}, Doctoral Dissertation, 156pp., Technical\n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
958 University @nospell{Graz}, Austria, 1994.\n\
10840
89f4d7e294cc Grammarcheck .cc files
Rik <octave@nomad.inbox5.com>
parents: 10791
diff changeset
959 \n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
960 @item For @var{l} > 1e8, use normal approximation.\n\
19040
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
961 @nospell{L. Montanet}, et al., @cite{Review of Particle Properties},\n\
0850b5212619 doc: Add @nospell macro around proper names in documentation.
Rik <rik@octave.org>
parents: 18679
diff changeset
962 Physical Review D 50 p1284, 1994.\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
963 @end table\n\
14655
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293)
David Bateman <dbateman@free.fr>
parents: 14620
diff changeset
964 \n\
17281
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
965 The class of the value returned can be controlled by a trailing\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
966 @qcode{\"double\"} or @qcode{\"single\"} argument. These are the only valid\n\
bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted.
Rik <rik@octave.org>
parents: 17258
diff changeset
967 classes.\n\
6547
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe]
jwe
parents: 6541
diff changeset
968 @seealso{rand, randn, rande, randg}\n\
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
969 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
970 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
971 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
972
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
973 if (nargin < 1)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
974 error ("randp: insufficient arguments");
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
975
20894
e528d7ab1cad rand.cc: Overhaul file to make use of new C++ archetype.
Rik <rik@octave.org>
parents: 20853
diff changeset
976 return do_rand (args, nargin, "randp", "poisson", true);
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
977 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
978
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
979 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
980 %!test
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
981 %! randp ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
982 %! assert (randp ([-inf, -1, 0, inf, nan]), [nan, nan, 0, nan, nan]); # *** Please report
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
983 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
984 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
985 %! randp ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
986 %! assert (randp (5, 1, 6), [5 5 3 7 7 3])
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
987 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
988 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
989 %! randp ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
990 %! assert (randp (15, 1, 6), [13 15 8 18 18 15])
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
991 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
992 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
993 %! randp ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
994 %! assert (randp (1e9, 1, 6), [999915677 999976657 1000047684 1000019035 999985749 999977692], -1e-6)
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
995 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
996 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
997 %! randp ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
998 %! %%assert (randp (5, 1, 6), [8 2 3 6 6 8])
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
999 %! assert (randp (5, 1, 5), [8 2 3 6 6])
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1000 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
1001 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1002 %! randp ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1003 %! assert (randp (15, 1, 6), [15 16 12 10 10 12])
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1004 %!test
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
1005 %! ## Test fixed state
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1006 %! randp ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1007 %! assert (randp (1e9, 1, 6), [1000006208 1000012224 999981120 999963520 999963072 999981440], -1e-6)
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1008 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1009 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
1010 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1011 %! randp ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1012 %! for a = [5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1013 %! x = randp (a (1), 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1014 %! assert (min (x) >= 0); # *** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1015 %! assert (mean (x), a(1), a(2));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1016 %! assert (var (x), a(1), 0.02*a(1));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1017 %! assert (skewness (x), 1/sqrt (a(1)), a(3));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1018 %! assert (kurtosis (x), 1/a(1), 3*a(3));
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1019 %! endfor
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1020 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1021 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1022 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
1023 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1024 %! randp ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1025 %! for a = [5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1026 %! x = randp (a(1)*ones (100000, 1), 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1027 %! assert (min (x) >= 0); # *** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1028 %! assert (mean (x), a(1), a(2));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1029 %! assert (var (x), a(1), 0.02*a(1));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1030 %! assert (skewness (x), 1/sqrt (a(1)), a(3));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1031 %! assert (kurtosis (x), 1/a(1), 3*a(3));
6437
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1032 %! endfor
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1033 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman]
dbateman
parents: 6198
diff changeset
1034 %!test
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1035 %! randp ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1036 %! assert (randp ([-inf, -1, 0, inf, nan]), [nan, nan, 0, nan, nan]); # *** Please report
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
1037 %!test
6449
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman]
dbateman
parents: 6443
diff changeset
1038 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
1039 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1040 %! randp ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1041 %! for a = [5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1042 %! x = randp (a(1), 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1043 %! assert (min (x) >= 0); # *** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1044 %! assert (mean (x), a(1), a(2));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1045 %! assert (var (x), a(1), 0.02*a(1));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1046 %! assert (skewness (x), 1/sqrt (a(1)), a(3));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1047 %! assert (kurtosis (x), 1/a(1), 3*a(3));
6449
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman]
dbateman
parents: 6443
diff changeset
1048 %! endfor
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman]
dbateman
parents: 6443
diff changeset
1049 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
1050 %!test
6449
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman]
dbateman
parents: 6443
diff changeset
1051 %! if (__random_statistical_tests__)
17336
b81b9d079515 Use '##' for comments which stand alone on a line.
Rik <rik@octave.org>
parents: 17281
diff changeset
1052 %! ## statistical tests may fail occasionally.
14501
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1053 %! randp ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1054 %! for a = [5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1055 %! x = randp (a(1)*ones (100000, 1), 100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1056 %! assert (min (x) >= 0); # *** Please report this!!! ***
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1057 %! assert (mean (x), a(1), a(2));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1058 %! assert (var (x), a(1), 0.02*a(1));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1059 %! assert (skewness (x), 1/sqrt (a(1)), a(3));
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions.
Rik <octave@nomad.inbox5.com>
parents: 14138
diff changeset
1060 %! assert (kurtosis (x), 1/a(1), 3*a(3));
6449
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman]
dbateman
parents: 6443
diff changeset
1061 %! endfor
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman]
dbateman
parents: 6443
diff changeset
1062 %! endif
5730
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
1063 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe]
jwe
parents: 5355
diff changeset
1064
15039
e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory
Rik <rik@octave.org>
parents: 14854
diff changeset
1065 DEFUN (randperm, args, ,
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
1066 "-*- texinfo -*-\n\
20853
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1067 @deftypefn {} {} randperm (@var{n})\n\
1142cf6abc0d 2015 Code Sprint: remove class of function from docstring for all C++ files.
Rik <rik@octave.org>
parents: 20831
diff changeset
1068 @deftypefnx {} {} randperm (@var{n}, @var{m})\n\
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1069 Return a row vector containing a random permutation of @code{1:@var{n}}.\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
1070 \n\
13186
2896c083576a Implement second randperm argument for compatibility with Matlab
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13026
diff changeset
1071 If @var{m} is supplied, return @var{m} unique entries, sampled without\n\
20172
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
1072 replacement from @code{1:@var{n}}.\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
1073 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
1074 The complexity is O(@var{n}) in memory and O(@var{m}) in time, unless\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
1075 @var{m} < @var{n}/5, in which case O(@var{m}) memory is used as well. The\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
1076 randomization is performed using rand(). All permutations are equally\n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line.
Rik <rik@octave.org>
parents: 19697
diff changeset
1077 likely.\n\
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1078 @seealso{perms}\n\
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1079 @end deftypefn")
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1080 {
13739
0206484682c6 rand.cc: Don't bring the whole std namespace into scope, only unordered_map
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13727
diff changeset
1081 #ifdef USE_UNORDERED_MAP_WITH_TR1
0206484682c6 rand.cc: Don't bring the whole std namespace into scope, only unordered_map
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13727
diff changeset
1082 using std::tr1::unordered_map;
0206484682c6 rand.cc: Don't bring the whole std namespace into scope, only unordered_map
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13727
diff changeset
1083 #else
0206484682c6 rand.cc: Don't bring the whole std namespace into scope, only unordered_map
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13727
diff changeset
1084 using std::unordered_map;
0206484682c6 rand.cc: Don't bring the whole std namespace into scope, only unordered_map
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13727
diff changeset
1085 #endif
0206484682c6 rand.cc: Don't bring the whole std namespace into scope, only unordered_map
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13727
diff changeset
1086
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1087 int nargin = args.length ();
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1088
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1089 if (nargin < 1 || nargin > 2)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1090 print_usage ();
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1091
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1092 octave_idx_type n = args(0).idx_type_value (true);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1093 octave_idx_type m = (nargin == 2) ? args(1).idx_type_value (true) : n;
11586
12df7854fa7c strip trailing whitespace from source files
John W. Eaton <jwe@octave.org>
parents: 11553
diff changeset
1094
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1095 if (m < 0 || n < 0)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1096 error ("randperm: M and N must be non-negative");
13186
2896c083576a Implement second randperm argument for compatibility with Matlab
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13026
diff changeset
1097
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1098 if (m > n)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1099 error ("randperm: M must be less than or equal to N");
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1100
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1101 // Quick and dirty heuristic to decide if we allocate or not the
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1102 // whole vector for tracking the truncated shuffle.
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1103 bool short_shuffle = m < n/5;
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1104
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1105 // Generate random numbers.
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1106 NDArray r = octave_rand::nd_array (dim_vector (1, m));
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1107 double *rvec = r.fortran_vec ();
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1108
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1109 octave_idx_type idx_len = short_shuffle ? m : n;
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1110 Array<octave_idx_type> idx;
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1111 try
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1112 {
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1113 idx = Array<octave_idx_type> (dim_vector (1, idx_len));
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1114 }
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1115 catch (const std::bad_alloc&)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1116 {
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1117 // Looks like n is too big and short_shuffle is false.
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1118 // Let's try again, but this time with the alternative.
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1119 idx_len = m;
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1120 short_shuffle = true;
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1121 idx = Array<octave_idx_type> (dim_vector (1, idx_len));
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1122 }
13186
2896c083576a Implement second randperm argument for compatibility with Matlab
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13026
diff changeset
1123
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1124 octave_idx_type *ivec = idx.fortran_vec ();
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1125
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1126 for (octave_idx_type i = 0; i < idx_len; i++)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1127 ivec[i] = i;
13255
dd3c5325039c Use a hash map to store permutations in randperm's truncated Knuth shuffle
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13186
diff changeset
1128
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1129 if (short_shuffle)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1130 {
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1131 unordered_map<octave_idx_type, octave_idx_type> map (m);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1132
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1133 // Perform the Knuth shuffle only keeping track of moved
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1134 // entries in the map
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1135 for (octave_idx_type i = 0; i < m; i++)
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1136 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1137 octave_idx_type k = i +
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1138 gnulib::floor (rvec[i] * (n - i));
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1139
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1140 // For shuffling first m entries, no need to use extra
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1141 // storage
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1142 if (k < m)
17662
0b7f5c56f853 Allow randperm to work with bigger inputs (bug #39378)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17336
diff changeset
1143 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1144 std::swap (ivec[i], ivec[k]);
13255
dd3c5325039c Use a hash map to store permutations in randperm's truncated Knuth shuffle
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13186
diff changeset
1145 }
dd3c5325039c Use a hash map to store permutations in randperm's truncated Knuth shuffle
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13186
diff changeset
1146 else
dd3c5325039c Use a hash map to store permutations in randperm's truncated Knuth shuffle
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13186
diff changeset
1147 {
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1148 if (map.find (k) == map.end ())
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1149 map[k] = k;
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1150
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1151 std::swap (ivec[i], map[k]);
13255
dd3c5325039c Use a hash map to store permutations in randperm's truncated Knuth shuffle
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13186
diff changeset
1152 }
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1153 }
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1154 }
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1155 else
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1156 {
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1157 // Perform the Knuth shuffle of the first m entries
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1158 for (octave_idx_type i = 0; i < m; i++)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1159 {
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1160 octave_idx_type k = i +
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1161 gnulib::floor (rvec[i] * (n - i));
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1162 std::swap (ivec[i], ivec[k]);
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1163 }
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1164 }
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1165
20801
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1166 // Convert to doubles, reusing r.
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1167 for (octave_idx_type i = 0; i < m; i++)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1168 rvec[i] = ivec[i] + 1;
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1169
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1170 if (m < n)
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1171 idx.resize (dim_vector (1, m));
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1172
a542a9bf177e eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20785
diff changeset
1173 // Now create an array object with a cached idx_vector.
21127
df7891224709 maint: Use "return ovl (...)" in DEFUN macros.
Rik <rik@octave.org>
parents: 21100
diff changeset
1174 return ovl (new octave_matrix (r, idx_vector (idx)));
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1175 }
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1176
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1177 /*
14688
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1178 %!assert (sort (randperm (20)), 1:20)
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1179 %!assert (length (randperm (20,10)), 10)
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1180
17662
0b7f5c56f853 Allow randperm to work with bigger inputs (bug #39378)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17336
diff changeset
1181 ## Test biggish N (bug #39378)
17812
fffd0c0ca2dc maint: A few Octave coding convention tweaks
Rik <rik@octave.org>
parents: 17787
diff changeset
1182 %!assert (length (randperm (30000^2, 100000)), 100000)
17662
0b7f5c56f853 Allow randperm to work with bigger inputs (bug #39378)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 17336
diff changeset
1183
14688
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1184 %!test
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1185 %! rand ("seed", 0);
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1186 %! for i = 1:100
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1187 %! p = randperm (305, 30);
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1188 %! assert (length (unique (p)), 30);
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 14138
diff changeset
1189 %! endfor
9647
54f45f883a53 optimize & extend randperm
Jaroslav Hajek <highegg@gmail.com>
parents: 9377
diff changeset
1190 */