annotate scripts/general/ind2sub.m @ 5518:a9bd6c31751f

[project @ 2005-10-29 04:26:38 by jwe]
author jwe
date Sat, 29 Oct 2005 04:28:23 +0000
parents 4c8a2e4e0717
children 2618a0750ae6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
1 ## Copyright (C) 2001 Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
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
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
7 ## the Free Software Foundation; either version 2, or (at your option)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
8 ## any later version.
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
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
16 ## along with Octave; see the file COPYING. If not, write to the Free
5307
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
17 ## Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
4c8a2e4e0717 [project @ 2005-04-26 19:24:27 by jwe]
jwe
parents: 5053
diff changeset
18 ## 02110-1301, USA.
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
19
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
20 ## -*- texinfo -*-
4906
6754342ef7ad [project @ 2004-06-23 11:11:50 by jwe]
jwe
parents: 4679
diff changeset
21 ## @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
22 ## Convert a linear index into subscripts.
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
23 ## @end deftypefn
5053
c08cb1098afc [project @ 2004-10-19 23:10:54 by jwe]
jwe
parents: 4906
diff changeset
24 ##
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
25 ## @seealso{sub2ind}
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
26
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
27 ## Author: Paul Kienzle <pkienzle@kienzle.powernet.co.uk>
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
28 ## Adapted-by: jwe
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
29
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
30 function varargout = ind2sub (dims, ind)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
31
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
32 if (nargin == 2)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
33 if (isvector (dims) && round (dims) == dims)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
34 if (isnumeric (ind) && round (ind) == ind)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
35 ntot = prod (dims);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
36 if (ind > 0 & ind <= ntot)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
37 nd = length (dims);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
38 if (nargout > 0)
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
39 vlen = nargout;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
40 else
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
41 vlen = 1;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
42 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
43 if (nd > vlen);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
44 dims(vlen) = prod (dims(vlen:nd));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
45 dims(vlen+1:nd) = [];
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
46 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
47 nd = length (dims);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
48 scale = [1; cumprod(dims(:))];
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
49 for i = nd:-1:2
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
50 k = (ind >= scale(i));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
51 r = ones (size (ind));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
52 t = zeros (size (ind));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
53 t(k) = floor ((ind(k) - 1) / scale(i));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
54 r(k) = t(k) + 1;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
55 varargout{i} = r;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
56 ind(k) -= t(k) * scale(i);
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
57 endfor
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
58 varargout{1} = ind;
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
59 for i = nd+1:vlen
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
60 varargout{i} = ones (size (ind));
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
61 endfor
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
62 else
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
63 error ("ind2sub: index out of range");
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
64 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
65 else
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
66 error ("ind2sub: expecting integer-valued index argument");
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
67 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
68 else
5518
a9bd6c31751f [project @ 2005-10-29 04:26:38 by jwe]
jwe
parents: 5307
diff changeset
69 error ("ind2sub: expecting dims to be an integer vector");
4679
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
70 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
71 else
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
72 usage ("ind2sub (dims, ind)");
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
73 endif
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
74
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
75
c0302db81b75 [project @ 2003-12-17 03:31:29 by jwe]
jwe
parents:
diff changeset
76 endfunction