octave-antonio: scripts/linear-algebra/commutation

annotate scripts/linear-algebra/commutation_matrix.m @ 20160:03b9d17a2d95 stable

doc: Update more docstrings to have one sentence summary as first line. Reviewed io, java, linear-algebra, prefs, and set script directories. * scripts/io/beep.m, scripts/io/dlmwrite.m, scripts/io/importdata.m, scripts/io/strread.m, scripts/io/textread.m, scripts/java/javaArray.m, scripts/java/java_get.m, scripts/java/java_set.m, scripts/java/javaaddpath.m, scripts/java/javachk.m, scripts/java/javaclasspath.m, scripts/java/javamem.m, scripts/java/javarmpath.m, scripts/linear-algebra/bandwidth.m, scripts/linear-algebra/commutation_matrix.m, scripts/linear-algebra/cond.m, scripts/linear-algebra/condest.m, scripts/linear-algebra/cross.m, scripts/linear-algebra/duplication_matrix.m, scripts/linear-algebra/expm.m, scripts/linear-algebra/housh.m, scripts/linear-algebra/isdefinite.m, scripts/linear-algebra/ishermitian.m, scripts/linear-algebra/issymmetric.m, scripts/linear-algebra/istril.m, scripts/linear-algebra/istriu.m, scripts/linear-algebra/krylov.m, scripts/linear-algebra/logm.m, scripts/linear-algebra/normest.m, scripts/linear-algebra/null.m, scripts/linear-algebra/onenormest.m, scripts/linear-algebra/orth.m, scripts/linear-algebra/qzhess.m, scripts/linear-algebra/rank.m, scripts/linear-algebra/rref.m, scripts/linear-algebra/vech.m, scripts/path/matlabroot.m, scripts/prefs/addpref.m, scripts/prefs/getpref.m, scripts/prefs/ispref.m, scripts/prefs/rmpref.m, scripts/prefs/setpref.m, scripts/set/powerset.m, scripts/set/setdiff.m: Update more docstrings to have one sentence summary as first line.

author	Rik <rik@octave.org>
date	Sun, 03 May 2015 15:36:23 -0700
parents	9fc020886ae9
children

rev	line source
19697 4197fc428c7d maint: Update copyright notices for 2015. John W. Eaton <jwe@octave.org> parents: 19040 diff changeset	1 ## Copyright (C) 1995-2015 Kurt Hornik
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	2 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	3 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	4 ##
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	5 ## Octave is free software; you can redistribute it and/or modify it
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 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.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	9 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	10 ## Octave is distributed in the hope that it will be useful, but
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	13 ## General Public License for more details.
f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	14 ##
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 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/>.
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	18
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	19 ## -- texinfo --
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	20 ## @deftypefn {Function File} {} commutation_matrix (@var{m}, @var{n})
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	21 ## Return the commutation matrix
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	22 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	23 ## $K_{m,n}$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	24 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	25 ## @ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	26 ## K(m,n)
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	27 ## @end ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	28 ## which is the unique
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	29 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	30 ## $m n \times m n$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	31 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	32 ## @ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	33 ## @var{m}@var{n} by @var{m}@var{n}
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	34 ## @end ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	35 ## matrix such that
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	36 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	37 ## $K_{m,n} \cdot {\rm vec} (A) = {\rm vec} (A^T)$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	38 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	39 ## @ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	40 ## @math{K(m,n) * vec(A) = vec(A')}
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	41 ## @end ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	42 ## for all
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	43 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	44 ## $m\times n$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	45 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	46 ## @ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	47 ## @math{m} by @math{n}
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	48 ## @end ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	49 ## matrices
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	50 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	51 ## $A$.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	52 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	53 ## @ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	54 ## @math{A}.
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	55 ## @end ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	56 ##
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	57 ## If only one argument @var{m} is given,
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	58 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	59 ## $K_{m,m}$
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	60 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	61 ## @ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	62 ## @math{K(m,m)}
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	63 ## @end ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	64 ## is returned.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	65 ##
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	66 ## See @nospell{Magnus and Neudecker} (1988), @cite{Matrix Differential
0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	67 ## Calculus with Applications in Statistics and Econometrics.}
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	68 ## @end deftypefn
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	69
5428 2a16423e4aa0 [project @ 2005-08-23 18:38:27 by jwe] jwe parents: 5307 diff changeset	70 ## Author: KH <Kurt.Hornik@wu-wien.ac.at>
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	71 ## Created: 8 May 1995
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	72 ## Adapted-By: jwe
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	73
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	74 function k = commutation_matrix (m, n)
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	75
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	76 if (nargin < 1 \|\| nargin > 2)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	77 print_usage ();
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	78 else
13279 984359717d71 Use common code idiom for checking whether a double value is an integer. Rik <octave@nomad.inbox5.com> parents: 12809 diff changeset	79 if (! (isscalar (m) && m == fix (m) && m > 0))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	80 error ("commutation_matrix: M must be a positive integer");
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	81 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	82 if (nargin == 1)
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	83 n = m;
13279 984359717d71 Use common code idiom for checking whether a double value is an integer. Rik <octave@nomad.inbox5.com> parents: 12809 diff changeset	84 elseif (! (isscalar (n) && n == fix (n) && n > 0))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 10791 diff changeset	85 error ("commutation_matrix: N must be a positive integer");
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	86 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	87 endif
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	88
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	89 ## It is clearly possible to make this a LOT faster!
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	90 k = zeros (m * n, m * n);
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	91 for i = 1 : m
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	92 for j = 1 : n
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	93 k((i - 1) * n + j, (j - 1) * m + i) = 1;
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	94 endfor
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	95 endfor
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	96
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	97 endfunction
12809 8dd680993088 codesprint: Wrote 6 tests for commutation_matrix.m Sean Young <seannz@gmail.com> parents: 11523 diff changeset	98
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	99
12809 8dd680993088 codesprint: Wrote 6 tests for commutation_matrix.m Sean Young <seannz@gmail.com> parents: 11523 diff changeset	100 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	101 %! c = commutation_matrix (1,1);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	102 %! assert (c,1);
12809 8dd680993088 codesprint: Wrote 6 tests for commutation_matrix.m Sean Young <seannz@gmail.com> parents: 11523 diff changeset	103
8dd680993088 codesprint: Wrote 6 tests for commutation_matrix.m Sean Young <seannz@gmail.com> parents: 11523 diff changeset	104 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	105 %! A = rand (3,5);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	106 %! vc = vec (A);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	107 %! vr = vec (A');
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	108 %! c = commutation_matrix (3,5);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	109 %! assert (c*vc, vr);
12809 8dd680993088 codesprint: Wrote 6 tests for commutation_matrix.m Sean Young <seannz@gmail.com> parents: 11523 diff changeset	110
8dd680993088 codesprint: Wrote 6 tests for commutation_matrix.m Sean Young <seannz@gmail.com> parents: 11523 diff changeset	111 %!test
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	112 %! A = rand (4,6);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	113 %! vc = vec (A);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	114 %! vr = vec (A');
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	115 %! c = commutation_matrix (4,6);
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	116 %! assert (c*vc, vr);
12809 8dd680993088 codesprint: Wrote 6 tests for commutation_matrix.m Sean Young <seannz@gmail.com> parents: 11523 diff changeset	117
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	118 %!error <M must be a positive integer> commutation_matrix (0,0)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	119 %!error <N must be a positive integer> commutation_matrix (1,0)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	120 %!error <M must be a positive integer> commutation_matrix (0,1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	121

Mercurial > octave-antonio

annotate scripts/linear-algebra/commutation_matrix.m @ 20160:03b9d17a2d95 stable