annotate scripts/general/randperm.m @ 7016:93c65f2a5668

[project @ 2007-10-12 06:40:56 by jwe]
author jwe
date Fri, 12 Oct 2007 06:41:26 +0000
parents 34f96dd5441b
children a1dbe9d80eee
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 1998 John W. Eaton
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
2 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
4 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
6 ## under the terms of the GNU General Public License as published by
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
7 ## the Free Software Foundation; either version 3 of the License, or (at
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
8 ## your option) any later version.
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
9 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
14 ##
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
15 ## 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: 6046
diff changeset
16 ## along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
17 ## <http://www.gnu.org/licenses/>.
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
18
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3276
diff changeset
19 ## -*- texinfo -*-
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3276
diff changeset
20 ## @deftypefn {Function File} {} randperm (@var{n})
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
21 ## Return a row vector containing a random permutation of the
3449
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3276
diff changeset
22 ## integers from 1 to @var{n}.
858695b3ed62 [project @ 2000-01-18 04:08:59 by jwe]
jwe
parents: 3276
diff changeset
23 ## @end deftypefn
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
24
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
25 ## Author: "James R. Van Zandt" <jrv@vanzandt.mv.com>
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
26 ## Adapted-By: jwe
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
27
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
28 function retval = randperm (n)
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
29
4030
22bd65326ec1 [project @ 2002-08-09 18:58:13 by jwe]
jwe
parents: 3449
diff changeset
30 if (nargin == 1 && isscalar (n) && floor (n) == n)
5500
709307492cd7 [project @ 2005-10-18 19:18:21 by jwe]
jwe
parents: 5307
diff changeset
31 if (n >= 0)
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
32 [junk, retval] = sort (rand (1, n));
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
33 else
5500
709307492cd7 [project @ 2005-10-18 19:18:21 by jwe]
jwe
parents: 5307
diff changeset
34 error ("randperm: argument must be non-negative");
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
35 endif
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
36 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5500
diff changeset
37 print_usage ();
3276
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
38 endif
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
39
edf6e4852287 [project @ 1999-10-12 05:49:45 by jwe]
jwe
parents:
diff changeset
40 endfunction