octave: libinterp/corefcn/rand.cc annotate

annotate libinterp/corefcn/rand.cc @ 20853:1142cf6abc0d

2015 Code Sprint: remove class of function from docstring for all C++ files.

author	Rik <rik@octave.org>
date	Sat, 12 Dec 2015 07:40:03 -0800
parents	35241c4b696c
children	e528d7ab1cad

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
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	26 #include <config.h>
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)
478efc95cb7a Test unordered_map header location and namespace. Michael Goffioul <michael.goffioul@gmail.com> parents: 13255 diff changeset	31 #include <unordered_map>
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)
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	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"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	44 #include "gripes.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	45 #include "oct-obj.h"
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 {
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	60 octave_value retval;
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	61 NDArray a;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	62 int idx = 0;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	63 dim_vector dims;
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	64 bool is_single = false;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	65
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	66 unwind_protect frame;
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	67 // Restore current distribution on any exit.
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	68 frame.add_fcn (octave_rand::distribution,
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	69 octave_rand::distribution ());
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	70
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	71 octave_rand::distribution (distribution);
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	72
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	73 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	74 {
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	75 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	76
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	77 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	78 {
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	79 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	80 nargin--;
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	81 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	82 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	83 nargin--;
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	84 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	85
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	86 if (additional_arg)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	87 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	88 if (nargin == 0)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20801 diff changeset	89 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	90 else if (args(0).is_string ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	91 additional_arg = false;
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	92 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	93 {
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	94 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	95
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	96 idx++;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	97 nargin--;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	98 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	99 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	100
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	101 switch (nargin)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	102 {
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	103 case 0:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	104 {
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	105 if (additional_arg)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	106 dims = a.dims ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	107 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	108 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	109 dims.resize (2);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	110
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	111 dims(0) = 1;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	112 dims(1) = 1;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	113 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	114 goto gen_matrix;
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	115 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	116 break;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	117
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	118 case 1:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	119 {
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	120 octave_value tmp = args(idx);
4543 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 if (tmp.is_string ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	123 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	124 std::string s_arg = tmp.string_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	125
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	126 if (s_arg == "dist")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	127 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	128 retval = octave_rand::distribution ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	129 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	130 else if (s_arg == "seed")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	131 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	132 retval = octave_rand::seed ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	133 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	134 else if (s_arg == "state" \|\| s_arg == "twister")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	135 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	136 retval = octave_rand::state (fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	137 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	138 else if (s_arg == "uniform")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	139 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	140 octave_rand::uniform_distribution ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	141 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	142 else if (s_arg == "normal")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	143 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	144 octave_rand::normal_distribution ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	145 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	146 else if (s_arg == "exponential")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	147 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	148 octave_rand::exponential_distribution ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	149 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	150 else if (s_arg == "poisson")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	151 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	152 octave_rand::poisson_distribution ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	153 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	154 else if (s_arg == "gamma")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	155 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	156 octave_rand::gamma_distribution ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	157 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	158 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	159 error ("%s: unrecognized string argument", fcn);
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_scalar_type ())
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 double dval = tmp.double_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	164
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	165 if (xisnan (dval))
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20801 diff changeset	166 error ("%s: NaN is invalid matrix dimension", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	167 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	168 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	169 dims.resize (2);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	170
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	171 dims(0) = NINTbig (tmp.double_value ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	172 dims(1) = NINTbig (tmp.double_value ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	173
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	174 goto gen_matrix;
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	175 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	176 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	177 else if (tmp.is_range ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	178 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	179 Range r = tmp.range_value ();
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	180
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	181 if (r.all_elements_are_ints ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	182 {
20228 00cf2847355d Deprecate Array::nelem() and Range::nelem() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20172 diff changeset	183 octave_idx_type n = r.numel ();
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	184
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	185 dims.resize (n);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	186
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	187 octave_idx_type base = NINTbig (r.base ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	188 octave_idx_type incr = NINTbig (r.inc ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	189
12905 f7a8d1dafda3 Let rand accept negative dimensions (bug #33301) Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12639 diff changeset	190 for (octave_idx_type i = 0; i < n; i++)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	191 {
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	192 // Negative dimensions are treated as zero for Matlab
7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	193 // compatibility
12905 f7a8d1dafda3 Let rand accept negative dimensions (bug #33301) Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12639 diff changeset	194 dims(i) = base >= 0 ? base : 0;
f7a8d1dafda3 Let rand accept negative dimensions (bug #33301) Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12639 diff changeset	195 base += incr;
f7a8d1dafda3 Let rand accept negative dimensions (bug #33301) Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12639 diff changeset	196 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	197
12905 f7a8d1dafda3 Let rand accept negative dimensions (bug #33301) Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12639 diff changeset	198 goto gen_matrix;
f7a8d1dafda3 Let rand accept negative dimensions (bug #33301) Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12639 diff changeset	199
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	200 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	201 else
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	202 error ("%s: all elements of range must be integers", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	203 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	204 else if (tmp.is_matrix_type ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	205 {
20743 b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	206 Array<int> iv;
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	207
20743 b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	208 try
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	209 {
20743 b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	210 iv = tmp.int_vector_value (true);
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	211 }
20785 b6f2909e7f94 always throw exception after debugging with debug_on_error John W. Eaton <jwe@octave.org> parents: 20756 diff changeset	212 catch (octave_execution_exception& e)
20743 b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	213 {
20756 200ae1d650b7 propagate octave_execution_exception objects through try/catch blocks John W. Eaton <jwe@octave.org> parents: 20743 diff changeset	214 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	215 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	216
20743 b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	217 octave_idx_type len = iv.numel ();
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	218
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	219 dims.resize (len);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	220
20743 b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	221 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	222 {
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	223 // Negative dimensions are treated as zero for Matlab
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	224 // compatibility
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	225 octave_idx_type elt = iv(i);
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	226 dims(i) = elt >=0 ? elt : 0;
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	227 }
20743 b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	228
b6408331bfa2 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20711 diff changeset	229 goto gen_matrix;
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	230 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	231 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	232 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	233 gripe_wrong_type_arg ("rand", tmp);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	234 return retval;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	235 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	236 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	237 break;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	238
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	239 default:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	240 {
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	241 octave_value tmp = args(idx);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	242
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	243 if (nargin == 2 && tmp.is_string ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	244 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	245 std::string ts = tmp.string_value ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: 4665 diff changeset	246
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	247 if (ts == "seed")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	248 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	249 if (args(idx+1).is_real_scalar ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	250 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	251 double d = args(idx+1).double_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	252
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	253 octave_rand::seed (d);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	254 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	255 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	256 && 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	257 octave_rand::reset ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	258 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	259 error ("%s: seed must be a real scalar", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	260 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	261 else if (ts == "state" \|\| ts == "twister")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	262 {
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	263 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	264 && 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	265 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	266 else
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	267 {
20687 5f04bfc7c17a backout changeset 18f38ed43962 John W. Eaton <jwe@octave.org> parents: 20682 diff changeset	268 ColumnVector s =
5f04bfc7c17a backout changeset 18f38ed43962 John W. Eaton <jwe@octave.org> parents: 20682 diff changeset	269 ColumnVector (args(idx+1).vector_value(false, true));
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	270
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	271 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	272 }
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	273 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	274 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	275 error ("%s: unrecognized string argument", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	276 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	277 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	278 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	279 dims.resize (nargin);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	280
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	281 for (int i = 0; i < nargin; i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	282 {
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	283 octave_idx_type elt = args(idx+i).xint_value ("%s: dimension must be a scalar or array of integers", fcn);
20704 571508c1ed06 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20687 diff changeset	284
20711 7b608fadc663 Make error messages more specific about the variable and problem encountered. Rik <rik@octave.org> parents: 20704 diff changeset	285 // Negative is zero for Matlab compatibility
12905 f7a8d1dafda3 Let rand accept negative dimensions (bug #33301) Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 12639 diff changeset	286 dims(i) = elt >= 0 ? elt : 0;
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	287 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	288
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	289 goto gen_matrix;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	290 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	291 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	292 break;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	293 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	294
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	295 done:
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	296
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	297 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	298
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	299 gen_matrix:
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	300
5355 cf44c749ba52 [project @ 2005-05-18 11:43:37 by jwe] jwe parents: 5307 diff changeset	301 dims.chop_trailing_singletons ();
cf44c749ba52 [project @ 2005-05-18 11:43:37 by jwe] jwe parents: 5307 diff changeset	302
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	303 if (is_single)
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	304 {
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	305 if (additional_arg)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	306 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	307 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	308 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	309 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	310 {
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	311 if (a.dims () != dims)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20801 diff changeset	312 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	313
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	314 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	315 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	316 float *v = m.fortran_vec ();
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	317 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	318 v[i] = octave_rand::float_scalar (a(i));
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	319 return m;
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	320 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	321 }
14655 43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	322 else
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 octave_rand::float_nd_array (dims);
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	324 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	325 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	326 {
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	327 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	328 {
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	329 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	330 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	331 else
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	332 {
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	333 if (a.dims () != dims)
20831 35241c4b696c eliminate return statements after calls to error John W. Eaton <jwe@octave.org> parents: 20801 diff changeset	334 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	335
20232 a9574e3c6e9e Deprecate Array::length() and Sparse::length() in favour of ::numel(). Carnë Draug <carandraug@octave.org> parents: 20228 diff changeset	336 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	337 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	338 double *v = m.fortran_vec ();
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	339 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	340 v[i] = octave_rand::scalar (a(i));
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	341 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	342 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	343 }
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	344 else
43db83eff9db Implement single precision rand, randn, rande, randg and randp generators (bug #34351, #36293) David Bateman <dbateman@free.fr> parents: 14620 diff changeset	345 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	346 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	347 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	348
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	349 DEFUN (rand, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	350 "-- 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	351 @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	352 @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	353 @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	354 @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	355 @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	356 @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	357 @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	358 @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	359 @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	360 @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	361 @deftypefnx {} {} rand (@dots{}, \"double\")\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	362 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	363 interval (0, 1).\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	364 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	365 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	366 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	367 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	368 \n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	369 @example\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	370 v = rand (\"state\")\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	371 @end example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	372 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	373 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	374 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	375 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	376 @example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	377 rand (\"state\", v)\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	378 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	379 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	380 @noindent\n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	381 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	382 @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	383 @var{v}, not @var{v} itself.\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	384 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	385 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	386 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	387 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	388 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	389 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	390 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	391 \n\
8325 b93ac0586e4b spelling corrections Brian Gough<bjg@network-theory.co.uk> parents: 7780 diff changeset	392 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	393 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	394 (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	395 @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	396 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	397 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	398 January 1998,\n\
7171 9bc096bc59d4 [project @ 2007-11-13 18:02:51 by jwe] jwe parents: 7096 diff changeset	399 @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	400 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	401 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	402 reading 624 consecutive values.\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	403 \n\
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	404 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	405 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	406 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	407 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	408 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	409 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	410 be used, as in\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	411 \n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	412 @example\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	413 rand (\"seed\", val)\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	414 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	415 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	416 @noindent\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	417 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	418 generator can be queried with\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	419 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	420 @example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	421 s = rand (\"seed\")\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	422 @end example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	423 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	424 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	425 @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	426 @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	427 @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	428 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	429 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	430 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	431 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17258 diff changeset	432 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	433 @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	434 classes.\n\
5798 7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe] jwe parents: 5782 diff changeset	435 @seealso{randn, rande, randg, randp}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	436 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	437 {
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	438 octave_value retval;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	439
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	440 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	441
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	442 retval = do_rand (args, nargin, "rand", "uniform");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	443
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	444 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	445 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	446
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	447 // 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	448 // 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	449
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	450 /*
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	451 %!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	452 %! 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	453 %! 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	454 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	455 %!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	456 %! 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	457 %! 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	458 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	459 %!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	460 %! 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	461 %! 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	462 %! 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	463 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	464 %! 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	465 %! assert (x, z);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	466 %!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	467 %! 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	468 %! 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	469 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	470 %!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	471 %!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	472 %! 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	473 %! 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	474 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	475 %!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	476 %! 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	477 %! 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	478 %! 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	479 %! assert (x, y);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	480 %! 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	481 %! assert (x, z);
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	482 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	483
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	484 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	485 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	486 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	487 %! rand ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	488 %! 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	489 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	490 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	491 %! rand ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	492 %! 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	493 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	494 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	495 %! ## 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	496 %! rand ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	497 %! x = rand (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	498 %! 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	499 %! 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	500 %! 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	501 %! 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	502 %! 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	503 %! assert (kurtosis (x), -6/5, 0.0094);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	504 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	505 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	506 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	507 %! ## 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	508 %! rand ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	509 %! x = rand (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	510 %! 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	511 %! 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	512 %! 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	513 %! 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	514 %! 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	515 %! assert (kurtosis (x), -6/5, 0.0094);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	516 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	517 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	518
17258 213ee68b59da Handle out-of-range values consistently when initializing random number generator. Philipp Kutin <philipp.kutin@gmail.com> parents: 15195 diff changeset	519 /*
213ee68b59da Handle out-of-range values consistently when initializing random number generator. Philipp Kutin <philipp.kutin@gmail.com> parents: 15195 diff changeset	520 %!# 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	521 %!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	522 %! 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	523 %! 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	524 %!endfunction
213ee68b59da Handle out-of-range values consistently when initializing random number generator. Philipp Kutin <philipp.kutin@gmail.com> parents: 15195 diff changeset	525 %!
213ee68b59da Handle out-of-range values consistently when initializing random number generator. Philipp Kutin <philipp.kutin@gmail.com> parents: 15195 diff changeset	526 %!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	527 %!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	528 %!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	529 %!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	530 */
213ee68b59da Handle out-of-range values consistently when initializing random number generator. Philipp Kutin <philipp.kutin@gmail.com> parents: 15195 diff changeset	531
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	532 static std::string current_distribution = octave_rand::distribution ();
fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	533
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	534 DEFUN (randn, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	535 "-- 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	536 @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	537 @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	538 @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	539 @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	540 @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	541 @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	542 @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	543 @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	544 @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	545 @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	546 @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	547 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	548 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	549 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	550 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	551 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 18679 diff changeset	552 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	553 ``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	554 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17258 diff changeset	555 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	556 @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	557 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	558 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 18679 diff changeset	559 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	560 @cite{Ziggurat Method for Generating Random Variables},\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	561 J. Statistical Software, vol 5, 2000,\n\
18679 a142f35f3cb6 doc: Fix unbalanced parentheses in documentation. Rik <rik@octave.org> parents: 18574 diff changeset	562 @url{http://www.jstatsoft.org/v05/i08/}\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	563 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	564 @seealso{rand, rande, randg, randp}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	565 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	566 {
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	567 octave_value retval;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	568
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	569 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	570
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	571 retval = do_rand (args, nargin, "randn", "normal");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	572
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	573 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	574 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	575
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	576 /*
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	577 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	578 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	579 %! randn ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	580 %! 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	581 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	582 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	583 %! randn ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	584 %! 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	585 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	586 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	587 %! ## 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	588 %! randn ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	589 %! x = randn (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	590 %! 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	591 %! 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	592 %! 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	593 %! assert (kurtosis (x), 0, 0.04);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	594 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	595 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	596 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	597 %! ## 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	598 %! randn ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	599 %! x = randn (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	600 %! 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	601 %! 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	602 %! 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	603 %! assert (kurtosis (x), 0, 0.04);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	604 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	605 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	606
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	607 DEFUN (rande, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	608 "-- 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	609 @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	610 @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	611 @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	612 @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	613 @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	614 @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	615 @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	616 @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	617 @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	618 @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	619 @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	620 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	621 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	622 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	623 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 18679 diff changeset	624 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	625 ``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	626 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17258 diff changeset	627 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	628 @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	629 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	630 \n\
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 18679 diff changeset	631 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	632 @cite{Ziggurat Method for Generating Random Variables},\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	633 J. Statistical Software, vol 5, 2000,\n\
18679 a142f35f3cb6 doc: Fix unbalanced parentheses in documentation. Rik <rik@octave.org> parents: 18574 diff changeset	634 @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	635 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	636 @seealso{rand, randn, randg, randp}\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	637 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	638 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	639 octave_value retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	640
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	641 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	642
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	643 retval = do_rand (args, nargin, "rande", "exponential");
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 return retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	646 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	647
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	648 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	649 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	650 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	651 %! rande ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	652 %! 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	653 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	654 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	655 %! rande ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	656 %! 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	657 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	658 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	659 %! ## 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	660 %! rande ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	661 %! x = rande (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	662 %! 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	663 %! 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	664 %! 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	665 %! 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	666 %! assert (kurtosis (x), 6, 0.7);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	667 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	668 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	669 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	670 %! ## 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	671 %! rande ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	672 %! x = rande (100000, 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	673 %! 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	674 %! 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	675 %! 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	676 %! 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	677 %! assert (kurtosis (x), 6, 0.7);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	678 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	679 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	680
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	681 DEFUN (randg, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	682 "-- 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	683 @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	684 @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	685 @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	686 @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	687 @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	688 @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	689 @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	690 @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	691 @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	692 @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	693 @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	694 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	695 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	696 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	697 for the argument @var{a}.\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	698 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	699 This can be used to generate many distributions:\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	700 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	701 @table @asis\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	702 @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	703 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	704 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	705 r = b * randg (a)\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	706 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	707 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	708 @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	709 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	710 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	711 @group\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	712 r1 = randg (a, 1)\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	713 r = r1 / (r1 + randg (b, 1))\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	714 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	715 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	716 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	717 @item @code{Erlang (a, n)}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	718 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	719 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	720 r = a * randg (n)\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	721 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	722 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	723 @item @code{chisq (df)} for @code{df > 0}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	724 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	725 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	726 r = 2 * randg (df / 2)\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\
12639 4d777e05d47c doc: Review and update documentation for "Matrix Manipulation" chapter. Rik <octave@nomad.inbox5.com> parents: 11586 diff changeset	729 @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	730 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	731 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	732 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	733 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	734 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	735 @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	736 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	737 @example\n\
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	738 @group\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	739 ## r1 equals 1 if n1 is infinite\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	740 r1 = 2 * randg (n1 / 2) / n1\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	741 ## r2 equals 1 if n2 is infinite\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	742 r2 = 2 * randg (n2 / 2) / n2\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	743 r = r1 / r2\n\n\
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	744 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	745 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	746 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	747 @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	748 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	749 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	750 r = randp ((1 - p) / p * randg (n))\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	751 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	752 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	753 @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	754 (use chisq if @code{L = 0})\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	755 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	756 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	757 @group\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	758 r = randp (L / 2)\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	759 r(r > 0) = 2 * randg (r(r > 0))\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	760 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	761 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	762 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	763 \n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	764 @item @code{Dirichlet (a1, @dots{} ak)}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	765 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	766 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	767 @group\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	768 r = (randg (a1), @dots{}, randg (ak))\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	769 r = r / sum (r)\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	770 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	771 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	772 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	773 @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	774 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17258 diff changeset	775 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	776 @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	777 classes.\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	778 @seealso{rand, randn, rande, randp}\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	779 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	780 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	781 octave_value retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	782
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	783 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	784
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	785 if (nargin < 1)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	786 error ("randg: insufficient arguments");
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	787 else
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	788 retval = do_rand (args, nargin, "randg", "gamma", true);
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	789
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	790 return retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	791 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	792
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	793 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	794 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	795 %! randg ("state", 12)
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	796 %! 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	797
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	798 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	799 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	800 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	801 %! 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	802 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	803 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	804 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	805 %! 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	806 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	807 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	808 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	809 %! 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	810 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	811 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	812 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	813 %! 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	814 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	815 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	816 %! randg ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	817 %! 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	818 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	819 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	820 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	821 %! 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	822 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	823 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	824 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	825 %! 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	826 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	827 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	828 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	829 %! 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	830 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	831 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	832 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	833 %! 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	834 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	835 %! ## Test fixed seed
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	836 %! randg ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	837 %! 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	838 %!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	839 %! ## 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	840 %! 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	841 %! 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	842 %! 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	843
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	844 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	845 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	846 %! ## 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	847 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	848 %! a = 0.1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	849 %! 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	850 %! 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	851 %! 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	852 %! 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	853 %! assert (kurtosis (x), 6/a, 50);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	854 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	855 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	856 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	857 %! ## 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	858 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	859 %! a = 0.95;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	860 %! 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	861 %! 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	862 %! 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	863 %! 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	864 %! 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	865 %! endif
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	866 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	867 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	868 %! ## 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	869 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	870 %! a = 1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	871 %! 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	872 %! 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	873 %! 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	874 %! 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	875 %! assert (kurtosis (x), 6/a, 2);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	876 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	877 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	878 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	879 %! ## 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	880 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	881 %! a = 10;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	882 %! 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	883 %! 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	884 %! 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	885 %! 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	886 %! assert (kurtosis (x), 6/a, 0.5);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	887 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	888 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	889 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	890 %! ## 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	891 %! randg ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	892 %! a = 100;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	893 %! 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	894 %! 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	895 %! 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	896 %! 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	897 %! 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	898 %! endif
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	899 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	900 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	901 %!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	902 %!test
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	903 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	904 %! ## 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	905 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	906 %! a = 0.1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	907 %! 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	908 %! 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	909 %! 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	910 %! 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	911 %! assert (kurtosis (x), 6/a, 50);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	912 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	913 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	914 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	915 %! ## 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	916 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	917 %! a = 0.95;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	918 %! 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	919 %! 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	920 %! 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	921 %! 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	922 %! assert (kurtosis (x), 6/a, 2);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	923 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	924 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	925 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	926 %! ## 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	927 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	928 %! a = 1;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	929 %! 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	930 %! 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	931 %! 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	932 %! 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	933 %! assert (kurtosis (x), 6/a, 2);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	934 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	935 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	936 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	937 %! ## 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	938 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	939 %! a = 10;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	940 %! 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	941 %! 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	942 %! 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	943 %! 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	944 %! assert (kurtosis (x), 6/a, 0.5);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	945 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	946 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	947 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	948 %! ## 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	949 %! randg ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	950 %! a = 100;
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	951 %! 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	952 %! 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	953 %! 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	954 %! 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	955 %! assert (kurtosis (x), 6/a, 0.2);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	956 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	957 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	958
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	959 DEFUN (randp, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	960 "-- 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	961 @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	962 @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	963 @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	964 @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	965 @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	966 @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	967 @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	968 @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	969 @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	970 @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	971 @deftypefnx {} {} randp (@dots{}, \"double\")\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	972 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	973 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	974 \n\
20172 4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	975 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	976 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	977 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	978 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	979 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	980 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	981 @table @asis\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	982 @item For scalar @var{l} @leq{} 12, use direct method.\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	983 W.H. Press, et al., @cite{Numerical Recipes in C},\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	984 Cambridge University Press, 1992.\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	985 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	986 @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	987 W.H. Press, et al., @cite{Numerical Recipes in C},\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	988 Cambridge University Press, 1992.\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	989 \n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	990 @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	991 @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	992 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	993 @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	994 @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	995 @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	996 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	997 University @nospell{Graz}, Austria, 1994.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	998 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	999 @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	1000 @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	1001 Physical Review D 50 p1284, 1994.\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1002 @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	1003 \n\
17281 bc924baa2c4e doc: Add new @qcode macro for code samples which are quoted. Rik <rik@octave.org> parents: 17258 diff changeset	1004 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	1005 @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	1006 classes.\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	1007 @seealso{rand, randn, rande, randg}\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1008 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1009 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1010 octave_value retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1011
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1012 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1013
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1014 if (nargin < 1)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1015 error ("randp: insufficient arguments");
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1016 else
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	1017 retval = do_rand (args, nargin, "randp", "poisson", true);
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1018
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1019 return retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1020 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1021
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1022 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1023 %!test
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 %! 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	1026 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1027 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1028 %! randp ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1029 %! 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	1030 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1031 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1032 %! randp ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1033 %! 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	1034 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1035 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1036 %! randp ("state", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1037 %! 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	1038 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1039 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1040 %! randp ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1041 %! %%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	1042 %! 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	1043 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1044 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1045 %! randp ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1046 %! 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	1047 %!test
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1048 %! ## Test fixed state
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1049 %! randp ("seed", 1);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1050 %! 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	1051 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	1052 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1053 %! ## 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	1054 %! randp ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1055 %! 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	1056 %! 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	1057 %! 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	1058 %! 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	1059 %! 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	1060 %! 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	1061 %! 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	1062 %! endfor
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	1063 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	1064 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	1065 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1066 %! ## 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	1067 %! randp ("state", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1068 %! 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	1069 %! 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	1070 %! 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	1071 %! 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	1072 %! 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	1073 %! 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	1074 %! 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	1075 %! endfor
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	1076 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	1077 %!test
14501 60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1078 %! randp ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1079 %! 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	1080 %!test
6449 a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1081 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1082 %! ## 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	1083 %! randp ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1084 %! 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	1085 %! 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	1086 %! 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	1087 %! 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	1088 %! 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	1089 %! 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	1090 %! 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	1091 %! endfor
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1092 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1093 %!test
6449 a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1094 %! if (__random_statistical_tests__)
17336 b81b9d079515 Use '##' for comments which stand alone on a line. Rik <rik@octave.org> parents: 17281 diff changeset	1095 %! ## 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	1096 %! randp ("seed", 12);
60e5cf354d80 Update %!tests in DLD-FUNCTIONS/ directory with Octave coding conventions. Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	1097 %! 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	1098 %! 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	1099 %! 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	1100 %! 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	1101 %! 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	1102 %! 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	1103 %! 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	1104 %! endfor
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1105 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1106 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1107
15039 e753177cde93 maint: Move non-dynamically linked functions from DLD-FUNCTIONS/ to corefcn/ directory Rik <rik@octave.org> parents: 14854 diff changeset	1108 DEFUN (randperm, args, ,
17787 175b392e91fe Use GNU style coding conventions for code in libinterp/ Rik <rik@octave.org> parents: 17744 diff changeset	1109 "-- 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	1110 @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	1111 @deftypefnx {} {} randperm (@var{n}, @var{m})\n\
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1112 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	1113 \n\
13186 2896c083576a Implement second randperm argument for compatibility with Matlab Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 13026 diff changeset	1114 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	1115 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	1116 \n\
4f45eaf83908 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19697 diff changeset	1117 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	1118 @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	1119 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	1120 likely.\n\
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1121 @seealso{perms}\n\
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1122 @end deftypefn")
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 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_value retval;
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	1125
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	1126 #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	1127 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	1128 #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	1129 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	1130 #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	1131
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1132 int nargin = args.length ();
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1133
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1134 if (nargin < 1 \|\| nargin > 2)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1135 print_usage ();
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 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	1138 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	1139
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1140 if (m < 0 \|\| n < 0)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1141 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	1142
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1143 if (m > n)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1144 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	1145
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1146 // 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	1147 // 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	1148 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	1149
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1150 // Generate random numbers.
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1151 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	1152 double *rvec = r.fortran_vec ();
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1153
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1154 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	1155 Array<octave_idx_type> idx;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1156 try
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1157 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1158 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	1159 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1160 catch (const std::bad_alloc&)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1161 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1162 // 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	1163 // 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	1164 idx_len = m;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1165 short_shuffle = true;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1166 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	1167 }
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	1168
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1169 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	1170
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1171 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	1172 ivec[i] = i;
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1173
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1174 if (short_shuffle)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1175 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1176 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	1177
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1178 // 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	1179 // entries in the map
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1180 for (octave_idx_type i = 0; i < m; i++)
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	1181 {
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1182 octave_idx_type k = i +
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1183 gnulib::floor (rvec[i] * (n - 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	1184
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1185 // 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	1186 // storage
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1187 if (k < m)
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	1188 {
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1189 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	1190 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1191 else
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1192 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1193 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	1194 map[k] = 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	1195
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1196 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	1197 }
20678 4b00afb5e9c3 eliminate more uses of error_state John W. Eaton <jwe@octave.org> parents: 20535 diff changeset	1198 }
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1199 }
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1200 else
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1201 {
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1202
20801 a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1203 // 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	1204 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	1205 {
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1206 octave_idx_type k = i +
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1207 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	1208 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	1209 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1210 }
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1211
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1212 // Convert to doubles, reusing r.
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1213 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	1214 rvec[i] = ivec[i] + 1;
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1215
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1216 if (m < n)
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1217 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	1218
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1219 // Now create an array object with a cached idx_vector.
a542a9bf177e eliminate return statements after calls to print_usage John W. Eaton <jwe@octave.org> parents: 20785 diff changeset	1220 return octave_value (new octave_matrix (r, idx_vector (idx)));
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1221 }
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1222
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1223 /*
14688 42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	1224 %!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	1225 %!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	1226
17662 0b7f5c56f853 Allow randperm to work with bigger inputs (bug #39378) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 17336 diff changeset	1227 ## Test biggish N (bug #39378)
17812 fffd0c0ca2dc maint: A few Octave coding convention tweaks Rik <rik@octave.org> parents: 17787 diff changeset	1228 %!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	1229
14688 42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	1230 %!test
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	1231 %! rand ("seed", 0);
42edbe6f6a8d Fix bad two-arg call of randperm (bug #36535) Jordi Gutiérrez Hermoso <jordigh@octave.org> parents: 14138 diff changeset	1232 %! 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	1233 %! 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	1234 %! 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	1235 %! endfor
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1236 */

Mercurial > octave

annotate libinterp/corefcn/rand.cc @ 20853:1142cf6abc0d