Mercurial > hg > octave-nkf

annotate scripts/general/blkdiag.m @ 11191:01ddaedd6ad5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Reverse changeset b1f4bdc276b6. Use all lower case for "uniformoutput" option.
author Rik <octave@nomad.inbox5.com>
date Thu, 04 Nov 2010 12:18:08 -0700
parents eb63fbe60fab
children 994e2a93a8e2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8920
eb63fbe60fab update copyright notices
John W. Eaton <jwe@octave.org>
parents: 8120
diff changeset
1 ## Copyright (C) 2000, 2005, 2006, 2007, 2008 Daniel Calvelo
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
3 ## This file is part of Octave.
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
5 ## Octave is free software; you can redistribute it and/or modify it
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
6 ## under the terms of the GNU General Public License as published by
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.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
10 ## Octave is distributed in the hope that it will be useful, but
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6046
diff changeset
13 ## General Public License for more details.
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
14 ##
71cfd8fedd5d [project @ 2005-11-30 03:26:50 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/>.
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
18
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
19 ## -*- texinfo -*-
5657
fb1de6e6343b [project @ 2006-03-09 19:21:39 by jwe]
jwe
parents: 5642
diff changeset
20 ## @deftypefn {Function File} {} blkdiag (@var{a}, @var{b}, @var{c}, @dots{})
fb1de6e6343b [project @ 2006-03-09 19:21:39 by jwe]
jwe
parents: 5642
diff changeset
21 ## Build a block diagonal matrix from @var{a}, @var{b}, @var{c}, @dots{}.
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
22 ## All the arguments must be numeric and are two-dimensional matrices or
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
23 ## scalars.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5601
diff changeset
24 ## @seealso{diag, horzcat, vertcat}
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
25 ## @end deftypefn
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
26
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
27 ## Author: Daniel Calvelo
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
28 ## Modified by: William Poetra Yoga Hadisoeseno
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
29
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
30 function retval = blkdiag (varargin)
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
31
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
32 if (nargin < 1)
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5989
diff changeset
33 print_usage ();
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
34 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
35
5989
e049385342f6 [project @ 2006-09-14 02:10:46 by jwe]
jwe
parents: 5720
diff changeset
36 if (! all (cellfun (@isnumeric, varargin)))
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
37 error ("blkdiag: all arguments must be numeric");
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
38 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
39
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
40 ## Note: trailing singletons are automatically (correctly) ignored.
5569
f7b4dfd541d1 [project @ 2005-12-08 16:57:31 by jwe]
jwe
parents: 5552
diff changeset
41 if (! all (cellfun ("ndims", varargin) == 2))
5657
fb1de6e6343b [project @ 2006-03-09 19:21:39 by jwe]
jwe
parents: 5642
diff changeset
42 error ("blkdiag: all arguments must be two-dimensional matrices");
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
43 endif
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
44
5552
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
45 ## size is an option for cellfun, but it's a bit different from
bcc328604953 [project @ 2005-11-30 05:48:59 by jwe]
jwe
parents: 5551
diff changeset
46 ## calling size directly.
11191
01ddaedd6ad5 Reverse changeset b1f4bdc276b6. Use all lower case for "uniformoutput" option.
Rik <octave@nomad.inbox5.com>
parents: 8920
diff changeset
47 tmp = cell2mat (cellfun (@size, varargin', "uniformoutput", false));
5989
e049385342f6 [project @ 2006-09-14 02:10:46 by jwe]
jwe
parents: 5720
diff changeset
48 csz = cumsum ([0 0; tmp], 1);
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
49 retval = zeros (csz(end,:));
5592
61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman]
dbateman
parents: 5574
diff changeset
50
61d6cebd243b [project @ 2006-01-12 17:55:22 by dbateman]
dbateman
parents: 5574
diff changeset
51 for p = 1:nargin
8120
8f0150a0d19e fix blkdiag to not rely on Matlab-incompatible behaviour
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
52 vp = varargin{p};
8f0150a0d19e fix blkdiag to not rely on Matlab-incompatible behaviour
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
53 if (! isempty (vp))
8f0150a0d19e fix blkdiag to not rely on Matlab-incompatible behaviour
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
54 retval((csz(p,1)+1):csz(p+1,1),(csz(p,2)+1):csz(p+1,2)) = vp;
8f0150a0d19e fix blkdiag to not rely on Matlab-incompatible behaviour
Jaroslav Hajek <highegg@gmail.com>
parents: 7017
diff changeset
55 endif
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
56 endfor
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
57
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
58 endfunction
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
59
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
60 # regular tests
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
61 %!assert(blkdiag(1,ones(2),1),[1,0,0,0;0,1,1,0;0,1,1,0;0,0,0,1])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
62 %!assert(blkdiag([1,2],[3,4],[5,6]),[1,2,0,0,0,0;0,0,3,4,0,0;0,0,0,0,5,6])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
63 %!assert(blkdiag([1,2],[3;4],[5,6]),[1,2,0,0,0;0,0,3,0,0;0,0,4,0,0;0,0,0,5,6])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
64 %!assert(blkdiag([1,2;3,4],[5,6,7]),[1,2,0,0,0;3,4,0,0,0;0,0,5,6,7])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
65 # tests involving empty matrices
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
66 %!assert(blkdiag([],[],[]),[])
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
67 %!assert(blkdiag([],[1,2;3,4],[],5,[]),[1,2,0;3,4,0;0,0,5])
5601
c8ed37d87923 [project @ 2006-01-21 20:08:33 by dbateman]
dbateman
parents: 5592
diff changeset
68 %!assert(blkdiag(zeros(1,0,1),[1,2,3],1,0,5,zeros(0,1,1)),[0,0,0,0,0,0,0;1,2,3,0,0,0,0;0,0,0,1,0,0,0;0,0,0,0,0,0,0;0,0,0,0,0,5,0]);
5551
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
69 # sanity checks
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
70 %!test
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
71 %! A = rand (round (rand (1, 2) * 10));
71cfd8fedd5d [project @ 2005-11-30 03:26:50 by jwe]
jwe
parents:
diff changeset
72 %! assert (blkdiag (A), A);