annotate scripts/general/postpad.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
2847
8b262e771614 [project @ 1997-03-27 16:18:26 by jwe]
jwe
parents: 2716
diff changeset
1 ## Copyright (C) 1996, 1997 John W. Eaton
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
2 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
3 ## This file is part of Octave.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
4 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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.
2313
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
9 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
13 ## General Public License for more details.
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
diff changeset
14 ##
5ca126254d15 [project @ 1996-07-11 21:25:22 by jwe]
jwe
parents: 2311
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/>.
2303
5cffc4b8de57 [project @ 1996-06-24 09:15:24 by jwe]
jwe
parents: 1337
diff changeset
18
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3428
diff changeset
19 ## -*- texinfo -*-
3500
7923abdeb4e5 [project @ 2000-01-31 06:35:00 by jwe]
jwe
parents: 3458
diff changeset
20 ## @deftypefn {Function File} {} postpad (@var{x}, @var{l}, @var{c})
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3202
diff changeset
21 ## See prepad.
3458
d25bc039237b [project @ 2000-01-19 09:36:14 by jwe]
jwe
parents: 3428
diff changeset
22 ## @end deftypefn
3428
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3202
diff changeset
23
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3202
diff changeset
24 ## Author: Tony Richardson <arichard@stark.cc.oh.us>
5b77cf82393c [project @ 2000-01-14 02:54:53 by jwe]
jwe
parents: 3202
diff changeset
25 ## Created: June 1994
904
3470f1e25a79 [project @ 1994-11-09 21:22:15 by jwe]
jwe
parents: 561
diff changeset
26
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
27 function y = postpad (x, l, c, dim)
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
28
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
29 if (nargin < 2 || nargin > 4)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5459
diff changeset
30 print_usage ();
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
31 endif
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
32
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
33 if (nargin < 3 || isempty (c))
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
34 c = 0;
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
35 else
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
36 if (! isscalar (c))
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
37 error ("postpad: third argument must be empty or a scalar");
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
38 endif
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
39 endif
561
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
40
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
41 nd = ndims (x);
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
42 sz = size (x);
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
43 if (nargin < 4)
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
44 %% Find the first non-singleton dimension
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
45 dim = 1;
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
46 while (dim < nd + 1 && sz (dim) == 1)
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
47 dim = dim + 1;
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
48 endwhile
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
49 if (dim > nd)
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
50 dim = 1;
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
51 endif
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
52 else
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
53 if (! (isscalar (dim) && dim == round (dim)) && dim > 0 &&
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
54 dim < (nd + 1))
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
55 error ("postpad: dim must be an integer and valid dimension");
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
56 endif
561
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
57 endif
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
58
5459
ff40c78cebf0 [project @ 2005-09-20 19:18:34 by jwe]
jwe
parents: 5307
diff changeset
59 if (! isscalar (l) || l < 0)
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
60 error ("second argument must be a positive scaler");
561
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
61 endif
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
62
5459
ff40c78cebf0 [project @ 2005-09-20 19:18:34 by jwe]
jwe
parents: 5307
diff changeset
63 if (dim > nd)
ff40c78cebf0 [project @ 2005-09-20 19:18:34 by jwe]
jwe
parents: 5307
diff changeset
64 sz(nd+1:dim) = 1;
ff40c78cebf0 [project @ 2005-09-20 19:18:34 by jwe]
jwe
parents: 5307
diff changeset
65 endif
ff40c78cebf0 [project @ 2005-09-20 19:18:34 by jwe]
jwe
parents: 5307
diff changeset
66
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
67 d = sz (dim);
5459
ff40c78cebf0 [project @ 2005-09-20 19:18:34 by jwe]
jwe
parents: 5307
diff changeset
68
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
69 if (d >= l)
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
70 idx = cell ();
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
71 for i = 1:nd
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
72 idx {i} = 1:sz(i);
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
73 endfor
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
74 idx {dim} = 1:l;
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
75 y = x (idx {:});
561
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
76 else
4862
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
77 sz (dim) = l - d;
a0997c4d1d54 [project @ 2004-04-15 21:14:43 by jwe]
jwe
parents: 4030
diff changeset
78 y = cat (dim, x, c * ones (sz));
561
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
79 endif
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
80
e79ff1f4df3c [project @ 1994-07-25 22:32:08 by jwe]
jwe
parents:
diff changeset
81 endfunction