octave: src/DLD-FUNCTIONS/rand.cc annotate

annotate src/DLD-FUNCTIONS/rand.cc @ 11586:12df7854fa7c

strip trailing whitespace from source files

author	John W. Eaton <jwe@octave.org>
date	Thu, 20 Jan 2011 17:24:59 -0500
parents	01f703952eff
children	4d777e05d47c

rev	line source
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	1 /*
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	2
11523 fd0a3ac60b0e update copyright notices John W. Eaton <jwe@octave.org> parents: 11493 diff changeset	3 Copyright (C) 1996-2011 John W. Eaton
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	4 Copyright (C) 2009 VZLU Prague
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	5
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	6 This file is part of Octave.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	7
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	8 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	9 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	10 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	11 option) any later version.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	12
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	13 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	14 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	15 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	16 for more details.
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	17
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	18 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	19 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	20 <http://www.gnu.org/licenses/>.
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	21
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 #ifdef HAVE_CONFIG_H
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	25 #include <config.h>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	26 #endif
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	27
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	28 #include <ctime>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	29
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	30 #include <string>
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	31
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	32 #include "f77-fcn.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	33 #include "lo-mappers.h"
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	34 #include "oct-rand.h"
4153 6b96ce9f5743 [project @ 2002-11-06 20:38:49 by jwe] jwe parents: 3887 diff changeset	35 #include "quit.h"
2928 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 "defun-dld.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	38 #include "error.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	39 #include "gripes.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	40 #include "oct-obj.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	41 #include "unwind-prot.h"
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	42 #include "utils.h"
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	43 #include "ov-re-mat.h"
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	44
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	45 /*
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	46 %!shared __random_statistical_tests__
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	47 %! % Flag whether the statistical tests should be run in "make check" or not
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	48 %! __random_statistical_tests__ = 0;
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	49 */
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	50
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	51 static octave_value
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	52 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	53 const std::string& distribution, bool additional_arg = false)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	54 {
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	55 octave_value retval;
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	56 NDArray a;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	57 int idx = 0;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	58 dim_vector dims;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	59
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	60 unwind_protect frame;
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	61 // Restore current distribution on any exit.
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	62 frame.add_fcn (octave_rand::distribution,
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	63 octave_rand::distribution ());
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	64
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	65 octave_rand::distribution (distribution);
d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	66
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	67 if (additional_arg)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	68 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	69 if (nargin == 0)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	70 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	71 error ("%s: expecting at least one argument", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	72 goto done;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	73 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	74 else if (args(0).is_string())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	75 additional_arg = false;
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	76 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	77 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	78 a = args(0).array_value ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	79 if (error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	80 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	81 error ("%s: expecting scalar or matrix arguments", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	82 goto done;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	83 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	84 idx++;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	85 nargin--;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	86 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	87 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	88
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	89 switch (nargin)
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	90 {
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	91 case 0:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	92 {
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	93 if (additional_arg)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	94 dims = a.dims ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	95 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	96 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	97 dims.resize (2);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	98
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	99 dims(0) = 1;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	100 dims(1) = 1;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	101 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	102 goto gen_matrix;
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	103 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	104 break;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	105
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	106 case 1:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	107 {
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	108 octave_value tmp = args(idx);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	109
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	110 if (tmp.is_string ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	111 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	112 std::string s_arg = tmp.string_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	113
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	114 if (s_arg == "dist")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	115 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	116 retval = octave_rand::distribution ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	117 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	118 else if (s_arg == "seed")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	119 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	120 retval = octave_rand::seed ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	121 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	122 else if (s_arg == "state" \|\| s_arg == "twister")
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 retval = octave_rand::state (fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	125 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	126 else if (s_arg == "uniform")
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 octave_rand::uniform_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 == "normal")
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 octave_rand::normal_distribution ();
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 == "exponential")
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 octave_rand::exponential_distribution ();
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 == "poisson")
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::poisson_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 == "gamma")
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::gamma_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
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	147 error ("%s: unrecognized string argument", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	148 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	149 else if (tmp.is_scalar_type ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	150 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	151 double dval = tmp.double_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	152
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	153 if (xisnan (dval))
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	154 {
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	155 error ("%s: NaN is invalid matrix dimension", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	156 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	157 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	158 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	159 dims.resize (2);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	160
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	161 dims(0) = NINTbig (tmp.double_value ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	162 dims(1) = NINTbig (tmp.double_value ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	163
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	164 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	165 goto gen_matrix;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	166 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	167 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	168 else if (tmp.is_range ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	169 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	170 Range r = tmp.range_value ();
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	171
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	172 if (r.all_elements_are_ints ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	173 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	174 octave_idx_type n = r.nelem ();
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	175
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	176 dims.resize (n);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	177
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	178 octave_idx_type base = NINTbig (r.base ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	179 octave_idx_type incr = NINTbig (r.inc ());
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	180 octave_idx_type lim = NINTbig (r.limit ());
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	181
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	182 if (base < 0 \|\| lim < 0)
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	183 error ("%s: all dimensions must be positive", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	184 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	185 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	186 for (octave_idx_type i = 0; i < n; i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	187 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	188 dims(i) = base;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	189 base += incr;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	190 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	191
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	192 goto gen_matrix;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	193 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	194 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	195 else
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	196 error ("%s: all elements of range must be integers",
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	197 fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	198 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	199 else if (tmp.is_matrix_type ())
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 Array<int> iv = tmp.int_vector_value (true);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	202
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	203 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	204 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	205 octave_idx_type len = iv.length ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	206
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	207 dims.resize (len);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	208
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	209 for (octave_idx_type i = 0; i < len; i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	210 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	211 octave_idx_type elt = iv(i);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	212
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	213 if (elt < 0)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	214 {
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	215 error ("%s: all dimensions must be positive", fcn);
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	216 goto done;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	217 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	218
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	219 dims(i) = iv(i);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	220 }
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	221
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	222 goto gen_matrix;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	223 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	224 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	225 error ("%s: expecting integer vector", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	226 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	227 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	228 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	229 gripe_wrong_type_arg ("rand", tmp);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	230 return retval;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	231 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	232 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	233 break;
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	234
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	235 default:
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	236 {
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	237 octave_value tmp = args(idx);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	238
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	239 if (nargin == 2 && tmp.is_string ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	240 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	241 std::string ts = tmp.string_value ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: 4665 diff changeset	242
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	243 if (ts == "seed")
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 if (args(idx+1).is_real_scalar ())
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	246 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	247 double d = args(idx+1).double_value ();
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	248
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	249 if (! error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	250 octave_rand::seed (d);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	251 }
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	252 else if (args(idx+1).is_string ()
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	253 && args(idx+1).string_value() == "reset")
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	254 octave_rand::reset ();
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	255 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	256 error ("%s: seed must be a real scalar", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	257 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	258 else if (ts == "state" \|\| ts == "twister")
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	259 {
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	260 if (args(idx+1).is_string ()
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	261 && args(idx+1).string_value() == "reset")
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	262 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	263 else
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	264 {
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	265 ColumnVector s =
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	266 ColumnVector (args(idx+1).vector_value(false, true));
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	267
10709 92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	268 if (! error_state)
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	269 octave_rand::state (s, fcn);
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	270 }
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	271 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	272 else
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	273 error ("%s: unrecognized string argument", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	274 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	275 else
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 dims.resize (nargin);
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	278
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	279 for (int i = 0; i < nargin; i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	280 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	281 dims(i) = args(idx+i).int_value ();
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	282
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	283 if (error_state)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	284 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	285 error ("%s: expecting integer arguments", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	286 goto done;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	287 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	288 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	289
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	290 goto gen_matrix;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	291 }
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	292 }
79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	293 break;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	294 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	295
4543 79df15d4470c [project @ 2003-10-18 03:53:52 by jwe] jwe parents: 4307 diff changeset	296 done:
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	297
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	298 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	299
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	300 gen_matrix:
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	301
5355 cf44c749ba52 [project @ 2005-05-18 11:43:37 by jwe] jwe parents: 5307 diff changeset	302 dims.chop_trailing_singletons ();
cf44c749ba52 [project @ 2005-05-18 11:43:37 by jwe] jwe parents: 5307 diff changeset	303
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	304 if (additional_arg)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	305 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	306 if (a.length() == 1)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	307 return octave_rand::nd_array (dims, a(0));
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	308 else
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	309 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	310 if (a.dims() != dims)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	311 {
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	312 error ("%s: mismatch in argument size", fcn);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	313 return retval;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	314 }
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	315 octave_idx_type len = a.length ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	316 NDArray m (dims);
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	317 double *v = m.fortran_vec ();
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	318 for (octave_idx_type i = 0; i < len; i++)
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	319 v[i] = octave_rand::scalar (a(i));
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	320 return m;
40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 10066 diff changeset	321 }
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	322 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	323 else
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	324 return octave_rand::nd_array (dims);
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	325 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	326
4665 dece11da64ed [project @ 2003-11-25 15:37:32 by jwe] jwe parents: 4664 diff changeset	327 DEFUN_DLD (rand, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	328 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	329 @deftypefn {Loadable Function} {} rand (@var{x})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	330 @deftypefnx {Loadable Function} {} rand (@var{n}, @var{m})\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	331 @deftypefnx {Loadable Function} {@var{v} =} rand (\"state\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	332 @deftypefnx {Loadable Function} {} rand (\"state\", @var{v})\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	333 @deftypefnx {Loadable Function} {} rand (\"state\", \"reset\")\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	334 @deftypefnx {Loadable Function} {@var{v} =} rand (\"seed\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	335 @deftypefnx {Loadable Function} {} rand (\"seed\", @var{v})\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	336 @deftypefnx {Loadable Function} {} rand (\"seed\", \"reset\")\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	337 Return a matrix with random elements uniformly distributed on the\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	338 interval (0, 1). The arguments are handled the same as the arguments\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	339 for @code{eye}.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	340 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	341 You can query the state of the random number generator using the\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	342 form\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	343 \n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	344 @example\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	345 v = rand (\"state\")\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	346 @end example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	347 \n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	348 This returns a column vector @var{v} of length 625. Later, you can\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	349 restore the random number generator to the state @var{v}\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	350 using the form\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	351 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	352 @example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	353 rand (\"state\", v)\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	354 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	355 \n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	356 @noindent\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	357 You may also initialize the state vector from an arbitrary vector of\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	358 length @leq{} 625 for @var{v}. This new state will be a hash based on the\n\
5798 7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe] jwe parents: 5782 diff changeset	359 value of @var{v}, not @var{v} itself.\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	360 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	361 By default, the generator is initialized from @code{/dev/urandom} if it is\n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	362 available, otherwise from CPU time, wall clock time and the current\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	363 fraction of a second.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	364 \n\
8325 b93ac0586e4b spelling corrections Brian Gough<bjg@network-theory.co.uk> parents: 7780 diff changeset	365 To compute the pseudo-random sequence, @code{rand} uses the Mersenne\n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	366 Twister with a period of @math{2^{19937}-1} (See M. Matsumoto and\n\
a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	367 T. Nishimura,\n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	368 @cite{Mersenne Twister: A 623-dimensionally equidistributed uniform \n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	369 pseudorandom number generator}, ACM Trans. on\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	370 Modeling and Computer Simulation Vol. 8, No. 1, pp. 3-30, January 1998,\n\
7171 9bc096bc59d4 [project @ 2007-11-13 18:02:51 by jwe] jwe parents: 7096 diff changeset	371 @url{http://www.math.sci.hiroshima-u.ac.jp/~m-mat/MT/emt.html}).\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	372 Do @strong{not} use for cryptography without securely hashing\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	373 several returned values together, otherwise the generator state\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	374 can be learned after reading 624 consecutive values.\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	375 \n\
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	376 Older versions of Octave used a different random number generator.\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	377 The new generator is used by default\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	378 as it is significantly faster than the old generator, and produces\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	379 random numbers with a significantly longer cycle time. However, in\n\
5798 7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe] jwe parents: 5782 diff changeset	380 some circumstances it might be desirable to obtain the same random\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	381 sequences as used by the old generators. To do this the keyword\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	382 \"seed\" is used to specify that the old generators should be use,\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	383 as in\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	384 \n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	385 @example\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	386 rand (\"seed\", val)\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	387 @end example\n\
f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	388 \n\
10846 a4f482e66b65 Grammarcheck more of the documentation. Rik <octave@nomad.inbox5.com> parents: 10840 diff changeset	389 @noindent\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	390 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	391 generator can be queried with\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	392 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	393 @example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	394 s = rand (\"seed\")\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	395 @end example\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	396 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	397 However, it should be noted that querying the seed will not cause\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	398 @code{rand} to use the old generators, only setting the seed will.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	399 To cause @code{rand} to once again use the new generators, the\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	400 keyword \"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	401 \n\
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	402 The state or seed of the generator can be reset to a new random value\n\
92a85ed5b86e Don't special case color_property type when emitting factory default (bug #30118) David Bateman <dbateman@free.fr> parents: 10687 diff changeset	403 using the \"reset\" keyword.\n\
5798 7e7ed81f5566 [project @ 2006-05-09 17:24:33 by jwe] jwe parents: 5782 diff changeset	404 @seealso{randn, rande, randg, randp}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	405 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	406 {
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	407 octave_value retval;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	408
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	409 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	410
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	411 retval = do_rand (args, nargin, "rand", "uniform");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	412
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	413 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	414 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	415
8871 fb1c929dbbb7 tests vs. 64-bit indexing John W. Eaton <jwe@octave.org> parents: 8828 diff changeset	416 // FIXME -- The old generator (selected when "seed" is set) will not
fb1c929dbbb7 tests vs. 64-bit indexing John W. Eaton <jwe@octave.org> parents: 8828 diff changeset	417 // 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	418
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	419 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	420 %!test # 'state' can be a scalar
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	421 %! rand('state',12); x = rand(1,4);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	422 %! rand('state',12); y = rand(1,4);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	423 %! assert(x,y);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	424 %!test # 'state' can be a vector
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	425 %! rand('state',[12,13]); x=rand(1,4);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	426 %! rand('state',[12;13]); y=rand(1,4);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	427 %! assert(x,y);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	428 %!test # querying 'state' doesn't disturb sequence
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	429 %! rand('state',12); rand(1,2); x=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	430 %! rand('state',12); rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	431 %! s=rand('state'); y=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	432 %! assert(x,y);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	433 %! rand('state',s); z=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	434 %! assert(x,z);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	435 %!test # 'seed' must be a scalar
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	436 %! rand('seed',12); x = rand(1,4);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	437 %! rand('seed',12); y = rand(1,4);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	438 %! assert(x,y);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	439 %!error(rand('seed',[12,13]))
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	440 %!test # querying 'seed' returns a value which can be used later
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	441 %! s=rand('seed'); x=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	442 %! rand('seed',s); y=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	443 %! assert(x,y);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	444 %!test # querying 'seed' doesn't disturb sequence
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	445 %! rand('seed',12); rand(1,2); x=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	446 %! rand('seed',12); rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	447 %! s=rand('seed'); y=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	448 %! assert(x,y);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	449 %! rand('seed',s); z=rand(1,2);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	450 %! assert(x,z);
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	451 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	452
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	453 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	454 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	455 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	456 %! rand("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	457 %! 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	458 %!test
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	459 %! % Test fixed seed
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	460 %! rand("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	461 %! 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	462 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	463 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	464 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	465 %! rand("state",12);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	466 %! x = rand(100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	467 %! assert(max(x)<1.); %* Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	468 %! assert(min(x)>0.); %* Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	469 %! assert(mean(x),0.5,0.0024);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	470 %! assert(var(x),1/48,0.0632);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	471 %! assert(skewness(x),0,0.012);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	472 %! assert(kurtosis(x),-6/5,0.0094);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	473 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	474 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	475 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	476 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	477 %! rand("seed",12);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	478 %! x = rand(100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	479 %! assert(max(x)<1.); %* Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	480 %! assert(min(x)>0.); %* Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	481 %! assert(mean(x),0.5,0.0024);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	482 %! assert(var(x),1/48,0.0632);
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	483 %! assert(skewness(x),0,0.012);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	484 %! assert(kurtosis(x),-6/5,0.0094);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	485 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	486 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	487
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	488
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	489 static std::string current_distribution = octave_rand::distribution ();
fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	490
4665 dece11da64ed [project @ 2003-11-25 15:37:32 by jwe] jwe parents: 4664 diff changeset	491 DEFUN_DLD (randn, args, ,
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	492 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	493 @deftypefn {Loadable Function} {} randn (@var{x})\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	494 @deftypefnx {Loadable Function} {} randn (@var{n}, @var{m})\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	495 @deftypefnx {Loadable Function} {@var{v} =} randn (\"state\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	496 @deftypefnx {Loadable Function} {} randn (\"state\", @var{v})\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	497 @deftypefnx {Loadable Function} {} randn (\"state\", \"reset\")\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	498 @deftypefnx {Loadable Function} {@var{v} =} randn (\"seed\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	499 @deftypefnx {Loadable Function} {} randn (\"seed\", @var{v})\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	500 @deftypefnx {Loadable Function} {} randn (\"seed\", \"reset\")\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	501 Return a matrix with normally distributed random\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	502 elements having zero mean and variance one. The arguments are\n\
7780 08125419efcb Extend explanation of randn's return value Thomas Weber <thomas.weber.mail@gmail.com> parents: 7533 diff changeset	503 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	504 \n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	505 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	506 to transform from a uniform to a normal distribution.\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	507 \n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	508 Reference: G. Marsaglia and W.W. Tsang,\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	509 @cite{Ziggurat Method for Generating Random Variables},\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	510 J. Statistical Software, vol 5, 2000,\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	511 @url{http://www.jstatsoft.org/v05/i08/})\n\
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	512 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	513 @seealso{rand, rande, randg, randp}\n\
3369 f37ca3017116 [project @ 1999-11-21 16:26:02 by jwe] jwe parents: 3325 diff changeset	514 @end deftypefn")
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	515 {
4307 fd034cd46aea [project @ 2003-01-24 19:20:50 by jwe] jwe parents: 4153 diff changeset	516 octave_value retval;
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	517
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	518 int nargin = args.length ();
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	519
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	520 retval = do_rand (args, nargin, "randn", "normal");
2928 295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	521
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	522 return retval;
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	523 }
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	524
295f037b4b3e [project @ 1997-05-05 05:32:33 by jwe] jwe parents: diff changeset	525 /*
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	526 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	527 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	528 %! randn("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	529 %! 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	530 %!test
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	531 %! % Test fixed seed
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	532 %! randn("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	533 %! 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	534 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	535 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	536 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	537 %! randn("state",12);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	538 %! x = randn(100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	539 %! assert(mean(x),0,0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	540 %! assert(var(x),1,0.02);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	541 %! assert(skewness(x),0,0.02);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	542 %! assert(kurtosis(x),0,0.04);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	543 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	544 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	545 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	546 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	547 %! randn("seed",12);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	548 %! x = randn(100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	549 %! assert(mean(x),0,0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	550 %! assert(var(x),1,0.02);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	551 %! assert(skewness(x),0,0.02);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	552 %! assert(kurtosis(x),0,0.04);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	553 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	554 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	555
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	556 DEFUN_DLD (rande, args, ,
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	557 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	558 @deftypefn {Loadable Function} {} rande (@var{x})\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	559 @deftypefnx {Loadable Function} {} rande (@var{n}, @var{m})\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	560 @deftypefnx {Loadable Function} {@var{v} =} rande (\"state\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	561 @deftypefnx {Loadable Function} {} rande (\"state\", @var{v})\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	562 @deftypefnx {Loadable Function} {} rande (\"state\", \"reset\")\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	563 @deftypefnx {Loadable Function} {@var{v} =} rande (\"seed\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	564 @deftypefnx {Loadable Function} {} rande (\"seed\", @var{v})\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	565 @deftypefnx {Loadable Function} {} rande (\"seed\", \"reset\")\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	566 Return a matrix with exponentially distributed random elements. The\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	567 arguments are handled the same as the arguments for @code{rand}.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	568 \n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	569 By default, @code{randn} uses the Marsaglia and Tsang ``Ziggurat technique''\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	570 to transform from a uniform to an exponential distribution.\n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	571 \n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	572 Reference: G. Marsaglia and W.W. Tsang,\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	573 @cite{Ziggurat Method for Generating Random Variables},\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	574 J. Statistical Software, vol 5, 2000,\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	575 @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	576 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	577 @seealso{rand, randn, randg, randp}\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	578 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	579 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	580 octave_value retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	581
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	582 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	583
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	584 retval = do_rand (args, nargin, "rande", "exponential");
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	585
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	586 return retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	587 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	588
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	589 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	590 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	591 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	592 %! rande("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	593 %! 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	594 %!test
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	595 %! % Test fixed seed
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	596 %! rande("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	597 %! 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	598 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	599 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	600 %! % statistical tests may fail occasionally
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	601 %! rande("state",1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	602 %! x = rande(100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	603 %! assert(min(x)>0); % * Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	604 %! assert(mean(x),1,0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	605 %! assert(var(x),1,0.03);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	606 %! assert(skewness(x),2,0.06);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	607 %! assert(kurtosis(x),6,0.7);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	608 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	609 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	610 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	611 %! % statistical tests may fail occasionally
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	612 %! rande("seed",1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	613 %! x = rande(100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	614 %! assert(min(x)>0); % * Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	615 %! assert(mean(x),1,0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	616 %! assert(var(x),1,0.03);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	617 %! assert(skewness(x),2,0.06);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	618 %! assert(kurtosis(x),6,0.7);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	619 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	620 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	621
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	622 DEFUN_DLD (randg, args, ,
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	623 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	624 @deftypefn {Loadable Function} {} randg (@var{a}, @var{x})\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	625 @deftypefnx {Loadable Function} {} randg (@var{a}, @var{n}, @var{m})\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	626 @deftypefnx {Loadable Function} {@var{v} =} randg (\"state\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	627 @deftypefnx {Loadable Function} {} randg (\"state\", @var{v})\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	628 @deftypefnx {Loadable Function} {} randg (\"state\", \"reset\")\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	629 @deftypefnx {Loadable Function} {@var{v} =} randg (\"seed\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	630 @deftypefnx {Loadable Function} {} randg (\"seed\", @var{v})\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	631 @deftypefnx {Loadable Function} {} randg (\"seed\", \"reset\")\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	632 Return a matrix with @code{gamma(@var{a},1)} distributed random elements.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	633 The arguments are handled the same as the arguments for @code{rand},\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	634 except for the argument @var{a}.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	635 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	636 This can be used to generate many distributions:\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	637 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	638 @table @asis\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	639 @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	640 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	641 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	642 r = b * randg (a)\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	643 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	644 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	645 @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	646 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	647 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	648 @group\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	649 r1 = randg (a, 1)\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	650 r = r1 / (r1 + randg (b, 1))\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	651 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	652 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	653 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	654 @item @code{Erlang (a, n)}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	655 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	656 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	657 r = a * randg (n)\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	658 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	659 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	660 @item @code{chisq (df)} for @code{df > 0}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	661 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	662 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	663 r = 2 * randg (df / 2)\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	664 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	665 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	666 @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	667 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	668 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	669 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	670 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	671 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	672 @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	673 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	674 @example\n\
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	675 @group\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	676 ## r1 equals 1 if n1 is infinite\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	677 r1 = 2 * randg (n1 / 2) / n1\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	678 ## r2 equals 1 if n2 is infinite\n\
81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	679 r2 = 2 * randg (n2 / 2) / n2\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	680 r = r1 / r2\n\n\
7096 81bed50b9feb [project @ 2007-11-02 16:13:43 by jwe] jwe parents: 7029 diff changeset	681 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	682 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	683 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	684 @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	685 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	686 @example\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	687 r = randp ((1 - p) / p * randg (n))\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	688 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	689 \n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	690 @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	691 (use chisq if @code{L = 0})\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	692 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	693 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	694 @group\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	695 r = randp (L / 2)\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	696 r(r > 0) = 2 * randg (r(r > 0))\n\
4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	697 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	698 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	699 @end example\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	700 \n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	701 @item @code{Dirichlet (a1, @dots{} ak)}\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	702 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	703 @example\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	704 @group\n\
9041 853f96e8008f Cleanup documentation file matrix.texi Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	705 r = (randg (a1), @dots{}, randg (ak))\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	706 r = r / sum (r)\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 9041 diff changeset	707 @end group\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	708 @end example\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 @end table\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	711 @seealso{rand, randn, rande, randp}\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	712 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	713 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	714 octave_value retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	715
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	716 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	717
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	718 if (nargin < 1)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	719 error ("randg: insufficient arguments");
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	720 else
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	721 retval = do_rand (args, nargin, "randg", "gamma", true);
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	722
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	723 return retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	724 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	725
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	726 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	727 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	728 %! randg("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	729 %!assert(randg([-inf,-1,0,inf,nan]),[nan,nan,nan,nan,nan]) % *** Please report
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	730
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	731
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	732 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	733 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	734 %! randg("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	735 %! 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	736 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	737 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	738 %! randg("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	739 %! 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	740 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	741 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	742 %! randg("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	743 %! 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	744 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	745 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	746 %! randg("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	747 %! 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	748 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	749 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	750 %! randg("state",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	751 %! 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	752 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	753 %! % Test fixed seed
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	754 %! randg("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	755 %! 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	756 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	757 %! % Test fixed seed
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	758 %! randg("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	759 %! 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	760 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	761 %! % Test fixed seed
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	762 %! randg("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	763 %! 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	764 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	765 %! % Test fixed seed
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	766 %! randg("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	767 %! 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	768 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	769 %! % Test fixed seed
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	770 %! randg("seed",1);
6443 9dc77e3c9313 [project @ 2007-03-23 16:28:00 by dbateman] dbateman parents: 6437 diff changeset	771 %! assert (randg(100,1,6), [89.40208435058594 101.4734725952148 103.4020004272461 93.62763214111328 88.33104705810547 88.1871337890625],1e-4);
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	772 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	773 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	774 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	775 %! randg("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	776 %! a=0.1; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	777 %! assert(mean(x), a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	778 %! assert(var(x), a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	779 %! assert(skewness(x),2/sqrt(a), 1.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	780 %! assert(kurtosis(x),6/a, 50.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	781 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	782 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	783 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	784 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	785 %! randg("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	786 %! a=0.95; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	787 %! assert(mean(x), a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	788 %! assert(var(x), a, 0.04);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	789 %! assert(skewness(x),2/sqrt(a), 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	790 %! assert(kurtosis(x),6/a, 2.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	791 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	792 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	793 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	794 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	795 %! randg("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	796 %! a=1; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	797 %! assert(mean(x),a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	798 %! assert(var(x),a, 0.04);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	799 %! assert(skewness(x),2/sqrt(a), 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	800 %! assert(kurtosis(x),6/a, 2.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	801 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	802 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	803 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	804 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	805 %! randg("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	806 %! a=10; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	807 %! assert(mean(x), a, 0.1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	808 %! assert(var(x), a, 0.5);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	809 %! assert(skewness(x),2/sqrt(a), 0.1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	810 %! assert(kurtosis(x),6/a, 0.5);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	811 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	812 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	813 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	814 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	815 %! randg("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	816 %! a=100; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	817 %! assert(mean(x), a, 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	818 %! assert(var(x), a, 2.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	819 %! assert(skewness(x),2/sqrt(a), 0.05);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	820 %! assert(kurtosis(x),6/a, 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	821 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	822 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	823 %! randg("seed",12)
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	824 %!assert(randg([-inf,-1,0,inf,nan]),[nan,nan,nan,nan,nan]) % *** Please report
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	825 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	826 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	827 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	828 %! randg("seed",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	829 %! a=0.1; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	830 %! assert(mean(x), a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	831 %! assert(var(x), a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	832 %! assert(skewness(x),2/sqrt(a), 1.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	833 %! assert(kurtosis(x),6/a, 50.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	834 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	835 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	836 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	837 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	838 %! randg("seed",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	839 %! a=0.95; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	840 %! assert(mean(x), a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	841 %! assert(var(x), a, 0.04);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	842 %! assert(skewness(x),2/sqrt(a), 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	843 %! assert(kurtosis(x),6/a, 2.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	844 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	845 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	846 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	847 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	848 %! randg("seed",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	849 %! a=1; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	850 %! assert(mean(x),a, 0.01);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	851 %! assert(var(x),a, 0.04);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	852 %! assert(skewness(x),2/sqrt(a), 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	853 %! assert(kurtosis(x),6/a, 2.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	854 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	855 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	856 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	857 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	858 %! randg("seed",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	859 %! a=10; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	860 %! assert(mean(x), a, 0.1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	861 %! assert(var(x), a, 0.5);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	862 %! assert(skewness(x),2/sqrt(a), 0.1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	863 %! assert(kurtosis(x),6/a, 0.5);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	864 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	865 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	866 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	867 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	868 %! randg("seed",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	869 %! a=100; x = randg(a,100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	870 %! assert(mean(x), a, 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	871 %! assert(var(x), a, 2.);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	872 %! assert(skewness(x),2/sqrt(a), 0.05);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	873 %! assert(kurtosis(x),6/a, 0.2);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	874 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	875 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	876
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	877
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	878 DEFUN_DLD (randp, args, ,
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	879 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	880 @deftypefn {Loadable Function} {} randp (@var{l}, @var{x})\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	881 @deftypefnx {Loadable Function} {} randp (@var{l}, @var{n}, @var{m})\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	882 @deftypefnx {Loadable Function} {@var{v} =} randp (\"state\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	883 @deftypefnx {Loadable Function} {} randp (\"state\", @var{v})\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	884 @deftypefnx {Loadable Function} {} randp (\"state\", \"reset\")\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	885 @deftypefnx {Loadable Function} {@var{v} =} randp (\"seed\")\n\
01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	886 @deftypefnx {Loadable Function} {} randp (\"seed\", @var{v})\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	887 @deftypefnx {Loadable Function} {} randp (\"seed\", \"reset\")\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	888 Return a matrix with Poisson distributed random elements with mean value\n\
a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	889 parameter given by the first argument, @var{l}. The arguments\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	890 are handled the same as the arguments for @code{rand}, except for the\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	891 argument @var{l}.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	892 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	893 Five different algorithms are used depending on the range of @var{l}\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	894 and whether or not @var{l} is a scalar or a matrix.\n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	895 \n\
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	896 @table @asis\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	897 @item For scalar @var{l} @leq{} 12, use direct method.\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	898 W.H. Press, et al., @cite{Numerical Recipes in C},\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	899 Cambridge University Press, 1992.\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	900 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	901 @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	902 W.H. Press, et al., @cite{Numerical Recipes in C},\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	903 Cambridge University Press, 1992.\n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	904 \n\
89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	905 @item For matrix @var{l} @leq{} 10, use inversion method.[2]\n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	906 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	907 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	908 @item For matrix @var{l} > 10, use patchwork rejection method.\n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	909 E. Stadlober, et al., WinRand source code, available via FTP, or\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	910 H. Zechner, @cite{Efficient sampling from continuous and discrete\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	911 unimodal distributions}, Doctoral Dissertation, 156pp., Technical\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	912 University Graz, Austria, 1994.\n\
10840 89f4d7e294cc Grammarcheck .cc files Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	913 \n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	914 @item For @var{l} > 1e8, use normal approximation.\n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	915 L. Montanet, et al., @cite{Review of Particle Properties}, Physical Review\n\
3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	916 D 50 p1284, 1994.\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	917 @end table\n\
6547 4fb053f24fd6 [project @ 2007-04-19 21:47:40 by jwe] jwe parents: 6541 diff changeset	918 @seealso{rand, randn, rande, randg}\n\
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	919 @end deftypefn")
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	920 {
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	921 octave_value retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	922
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	923 int nargin = args.length ();
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	924
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	925 if (nargin < 1)
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	926 error ("randp: insufficient arguments");
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	927 else
10782 d1f920d1ce0c simplify code in rand.cc Jaroslav Hajek <highegg@gmail.com> parents: 10709 diff changeset	928 retval = do_rand (args, nargin, "randp", "poisson", true);
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	929
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	930 return retval;
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	931 }
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	932
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	933 /*
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	934 %!test
6437 190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	935 %! randp("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	936 %!assert(randp([-inf,-1,0,inf,nan]),[nan,nan,0,nan,nan]); % *** Please report
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	937 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	938 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	939 %! randp("state",1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	940 %! assert(randp(5,1,6),[5 5 3 7 7 3])
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	941 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	942 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	943 %! randp("state",1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	944 %! assert(randp(15,1,6),[13 15 8 18 18 15])
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	945 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	946 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	947 %! randp("state",1);
7421 1c7b3e1fda19 [project @ 2008-01-25 21:00:42 by dbateman] dbateman parents: 7171 diff changeset	948 %! 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	949 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	950 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	951 %! randp("seed",1);
6449 a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	952 %! %%assert(randp(5,1,6),[8 2 3 6 6 8])
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	953 %! 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	954 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	955 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	956 %! randp("seed",1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	957 %! assert(randp(15,1,6),[15 16 12 10 10 12])
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	958 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	959 %! % Test fixed state
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	960 %! randp("seed",1);
7421 1c7b3e1fda19 [project @ 2008-01-25 21:00:42 by dbateman] dbateman parents: 7171 diff changeset	961 %! 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	962 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	963 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	964 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	965 %! randp("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	966 %! for a=[5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	967 %! x = randp(a(1),100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	968 %! assert(min(x)>=0); % * Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	969 %! assert(mean(x),a(1),a(2));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	970 %! assert(var(x),a(1),0.02*a(1));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	971 %! assert(skewness(x),1/sqrt(a(1)),a(3));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	972 %! assert(kurtosis(x),1/a(1),3*a(3));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	973 %! endfor
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	974 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	975 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	976 %! if (__random_statistical_tests__)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	977 %! % statistical tests may fail occasionally.
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	978 %! randp("state",12)
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	979 %! for a=[5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	980 %! x = randp(a(1)*ones(100000,1),100000,1);
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	981 %! assert(min(x)>=0); % * Please report this!!! *
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	982 %! assert(mean(x),a(1),a(2));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	983 %! assert(var(x),a(1),0.02*a(1));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	984 %! assert(skewness(x),1/sqrt(a(1)),a(3));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	985 %! assert(kurtosis(x),1/a(1),3*a(3));
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	986 %! endfor
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	987 %! endif
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	988 %!test
190dfe8b8f08 [project @ 2007-03-23 14:17:31 by dbateman] dbateman parents: 6198 diff changeset	989 %! randp("seed",12)
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	990 %!assert(randp([-inf,-1,0,inf,nan]),[nan,nan,0,nan,nan]); % *** Please report
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	991 %!test
6449 a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	992 %! if (__random_statistical_tests__)
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	993 %! % statistical tests may fail occasionally.
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	994 %! randp("seed",12)
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	995 %! for a=[5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	996 %! x = randp(a(1),100000,1);
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	997 %! assert(min(x)>=0); % * Please report this!!! *
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	998 %! assert(mean(x),a(1),a(2));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	999 %! assert(var(x),a(1),0.02*a(1));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1000 %! assert(skewness(x),1/sqrt(a(1)),a(3));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1001 %! assert(kurtosis(x),1/a(1),3*a(3));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1002 %! endfor
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1003 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1004 %!test
6449 a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1005 %! if (__random_statistical_tests__)
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1006 %! % statistical tests may fail occasionally.
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1007 %! randp("seed",12)
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1008 %! for a=[5, 15, 1e9; 0.03, 0.03, -5e-3; 0.03, 0.03, 0.03]
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1009 %! x = randp(a(1)*ones(100000,1),100000,1);
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1010 %! assert(min(x)>=0); % * Please report this!!! *
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1011 %! assert(mean(x),a(1),a(2));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1012 %! assert(var(x),a(1),0.02*a(1));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1013 %! assert(skewness(x),1/sqrt(a(1)),a(3));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1014 %! assert(kurtosis(x),1/a(1),3*a(3));
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1015 %! endfor
a5de12c0f968 [project @ 2007-03-24 11:11:36 by dbateman] dbateman parents: 6443 diff changeset	1016 %! endif
5730 109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1017 */
109fdf7b3dcb [project @ 2006-04-03 19:18:26 by jwe] jwe parents: 5355 diff changeset	1018
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1019 DEFUN_DLD (randperm, args, ,
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1020 "-- texinfo --\n\
10687 a8ce6bdecce5 Improve documentation strings. Rik <octave@nomad.inbox5.com> parents: 10155 diff changeset	1021 @deftypefn {Loadable Function} {} randperm (@var{n})\n\
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1022 @deftypefnx {Loadable Function} {} randperm (@var{n}, @var{m})\n\
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1023 Return a row vector containing a random permutation of @code{1:@var{n}}.\n\
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1024 If @var{m} is supplied, return @var{m} permutations,\n\
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	1025 one in each row of an @nospell{NxM} matrix. The complexity is O(M*N) in both\n\
10791 3140cb7a05a1 Add spellchecker scripts for Octave and run spellcheck of documentation Rik <octave@nomad.inbox5.com> parents: 10787 diff changeset	1026 time and memory. The randomization is performed using rand().\n\
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1027 All permutations are equally likely.\n\
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1028 @seealso{perms}\n\
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1029 @end deftypefn")
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1030 {
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1031 int nargin = args.length ();
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1032 octave_value retval;
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1033
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1034 if (nargin == 1 \|\| nargin == 2)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1035 {
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1036 octave_idx_type n, m;
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	1037
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1038 if (nargin == 2)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1039 m = args(1).idx_type_value (true);
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1040 else
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1041 m = 1;
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1042
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1043 n = args(0).idx_type_value (true);
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1044
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1045 if (m < 0 \|\| n < 0)
11553 01f703952eff Improve docstrings for functions in DLD-FUNCTIONS directory. Rik <octave@nomad.inbox5.com> parents: 11523 diff changeset	1046 error ("randperm: M and N must be non-negative");
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1047
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1048 if (! error_state)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1049 {
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1050 // Generate random numbers.
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1051 NDArray r = octave_rand::nd_array (dim_vector (m, n));
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1052
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1053 // Create transposed to allow faster access.
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1054 Array<octave_idx_type> idx (dim_vector (n, m));
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1055
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1056 double *rvec = r.fortran_vec ();
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1057
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1058 octave_idx_type *ivec = idx.fortran_vec ();
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1059
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1060 // Perform the Knuth shuffle.
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1061 for (octave_idx_type j = 0; j < m; j++)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1062 {
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1063 for (octave_idx_type i = 0; i < n; i++)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1064 ivec[i] = i;
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1065
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1066 for (octave_idx_type i = 0; i < n; i++)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1067 {
11450 5eb10763069f substitute and use LAPACK_LIBS in mkoctfile script John W. Eaton <jwe@octave.org> parents: 10846 diff changeset	1068 octave_idx_type k = i + gnulib::floor (rvec[i] * (n - i));
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1069 std::swap (ivec[i], ivec[k]);
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1070 }
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1071
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1072 ivec += n;
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1073 rvec += n;
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1074 }
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1075
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1076 // Transpose.
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1077 idx = idx.transpose ();
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1078
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1079 // Re-fetch the pointers.
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1080 ivec = idx.fortran_vec ();
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1081 rvec = r.fortran_vec ();
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1082
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1083 // Convert to doubles, reusing r.
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1084 for (octave_idx_type i = 0, l = m*n; i < l; i++)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1085 rvec[i] = ivec[i] + 1;
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1086
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1087 // Now create an array object with a cached idx_vector.
11586 12df7854fa7c strip trailing whitespace from source files John W. Eaton <jwe@octave.org> parents: 11553 diff changeset	1088 retval = new octave_matrix (r, idx_vector (idx));
9647 54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1089 }
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1090 }
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1091 else
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1092 print_usage ();
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1093
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1094 return retval;
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1095 }
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1096
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1097 /*
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1098 %!assert(sort(randperm(20)),1:20)
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1099 %!assert(sort(randperm(20,50),2),repmat(1:20,50,1))
54f45f883a53 optimize & extend randperm Jaroslav Hajek <highegg@gmail.com> parents: 9377 diff changeset	1100 */

Mercurial > octave

annotate src/DLD-FUNCTIONS/rand.cc @ 11586:12df7854fa7c