annotate scripts/general/ind2sub.m @ 7017:a1dbe9d80eee

[project @ 2007-10-12 21:27:11 by jwe]
author jwe
date Fri, 12 Oct 2007 21:27:37 +0000
parents 93c65f2a5668
children 74075b3b54c1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
1 ## Copyright (C) 2001, 2003, 2004, 2005, 2006, 2007 Paul Kienzle
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
2 ##
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
3 ## This file is part of Octave.
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
4 ##
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
c0302db81b75 [project @ 2003-12-17 03:31:29 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: 6631
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: 6631
diff changeset
8 ## your option) any later version.
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
9 ##
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
13 ## General Public License for more details.
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
14 ##
c0302db81b75 [project @ 2003-12-17 03:31:29 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: 6631
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: 6631
diff changeset
17 ## <http://www.gnu.org/licenses/>.
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
18
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
4906
6754342ef7ad [project @ 2004-06-23 11:11:50 by jwe]
jwe
parents: 4679
diff changeset
20 ## @deftypefn {Function File} {[@var{s1}, @var{s2}, @dots{}, @var{sN}] =} ind2sub (@var{dims}, @var{ind})
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
21 ## Convert a linear index into subscripts.
6631
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
22 ##
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
23 ## The following example shows how to convert the linear index @code{8}
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
24 ## in a 3-by-3 matrix into a subscript.
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
25 ##
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
26 ## @example
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
27 ## [r, c] = ind2sub ([3, 3], 8)
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
28 ## @result{} r = 2
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
29 ## c = 3
1b8daf8c0397 [project @ 2007-05-16 16:11:55 by jwe]
jwe
parents: 6050
diff changeset
30 ## @end example
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5518
diff changeset
31 ## @seealso{sub2ind}
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
32 ## @end deftypefn
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
33
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
34 ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
35 ## Adapted-by: jwe
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
36
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
37 function varargout = ind2sub (dims, ind)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
38
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
39 if (nargin == 2)
6050
435294ca4ee6 [project @ 2006-10-13 17:42:21 by jwe]
jwe
parents: 6046
diff changeset
40 if (isvector (dims) && all (round (dims) == dims))
435294ca4ee6 [project @ 2006-10-13 17:42:21 by jwe]
jwe
parents: 6046
diff changeset
41 if (isnumeric (ind) && all (round (ind) == ind))
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
42 ntot = prod (dims);
6050
435294ca4ee6 [project @ 2006-10-13 17:42:21 by jwe]
jwe
parents: 6046
diff changeset
43 if (all (ind > 0 & ind <= ntot))
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
44 nd = length (dims);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
45 if (nargout > 0)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
46 vlen = nargout;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
47 else
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
48 vlen = 1;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
49 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
50 if (nd > vlen);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
51 dims(vlen) = prod (dims(vlen:nd));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
52 dims(vlen+1:nd) = [];
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
53 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
54 nd = length (dims);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
55 scale = [1; cumprod(dims(:))];
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
56 for i = nd:-1:2
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
57 k = (ind >= scale(i));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
58 r = ones (size (ind));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
59 t = zeros (size (ind));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
60 t(k) = floor ((ind(k) - 1) / scale(i));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
61 r(k) = t(k) + 1;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
62 varargout{i} = r;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
63 ind(k) -= t(k) * scale(i);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
64 endfor
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
65 varargout{1} = ind;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
66 for i = nd+1:vlen
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
67 varargout{i} = ones (size (ind));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
68 endfor
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
69 else
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
70 error ("ind2sub: index out of range");
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
71 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
72 else
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
73 error ("ind2sub: expecting integer-valued index argument");
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
74 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
75 else
5518
a9bd6c31751f [project @ 2005-10-29 04:26:38 by jwe]
jwe
parents: 5307
diff changeset
76 error ("ind2sub: expecting dims to be an integer vector");
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
77 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
78 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
79 print_usage ();
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
80 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
81
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
82
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
83 endfunction