octave: scripts/linear-algebra/duplication

annotate scripts/linear-algebra/duplication_matrix.m @ 33634:4a70f390c85e default tip @

maint: Merge stable to default.

author	Markus Mützel <markus.muetzel@gmx.de>
date	Tue, 28 May 2024 15:25:54 +0200
parents	2e484f9f1f18
children

rev	line source
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	1 ########################################################################
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	2 ##
32632 2e484f9f1f18 maint: update Octave Project Developers copyright for the new year John W. Eaton <jwe@octave.org> parents: 31706 diff changeset	3 ## Copyright (C) 1995-2024 The Octave Project Developers
27918 b442ec6dda5c use centralized file for copyright info for individual contributors John W. Eaton <jwe@octave.org> parents: 27800 diff changeset	4 ##
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	5 ## See the file COPYRIGHT.md in the top-level directory of this
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	6 ## distribution or <https://octave.org/copyright/>.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	7 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	8 ## This file is part of Octave.
38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	9 ##
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	10 ## Octave is free software: you can redistribute it and/or modify it
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	11 ## under the terms of the GNU General Public License as published by
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	12 ## the Free Software Foundation, either version 3 of the License, or
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	13 ## (at your option) any later version.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	14 ##
3922 38c61cbf086c [project @ 2002-05-01 06:48:35 by jwe] jwe parents: 3499 diff changeset	15 ## 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	16 ## WITHOUT ANY WARRANTY; without even the implied warranty of
22755 3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	17 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a2b891d0b33 maint: Standardize Copyright formatting. Rik <rik@octave.org> parents: 22323 diff changeset	18 ## GNU General Public License for more details.
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	19 ##
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	20 ## 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	21 ## along with Octave; see the file COPYING. If not, see
24534 194eb4bd202b maint: Update punctuation for GPL v3 license text. Rik <rik@octave.org> parents: 23220 diff changeset	22 ## <https://www.gnu.org/licenses/>.
27923 bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	23 ##
bd51beb6205e update formatting of copyright notices John W. Eaton <jwe@octave.org> parents: 27919 diff changeset	24 ########################################################################
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	25
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	26 ## -- texinfo --
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	27 ## @deftypefn {} {@var{d} =} duplication_matrix (@var{n})
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	28 ## Return the duplication matrix
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 ## $D_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 ## @nospell{@math{Dn}}
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 ## which is the unique
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 ## $n^2 \times n(n+1)/2$
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
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	40 ## @math{N^2}-by-@math{N*(N+1)/2}
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 ## matrix such that
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 ## $D_n * {\rm vech} (A) = {\rm vec} (A)$
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
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	47 ## @nospell{@code{Dn * vech (A) = vec (A)}}
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 ## for all symmetric
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 ## $n \times n$
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
30875 5d3faba0342e doc: Ensure documentation lists output argument when it exists for all m-files. Rik <rik@octave.org> parents: 30564 diff changeset	54 ## @math{N}-by-@math{N}
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	55 ## @end ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	56 ## matrices
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	57 ## @tex
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	58 ## $A$.
6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	59 ## @end tex
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	60 ## @ifnottex
20160 03b9d17a2d95 doc: Update more docstrings to have one sentence summary as first line. Rik <rik@octave.org> parents: 19833 diff changeset	61 ## @math{A}.
8517 81d6ab3ac93c Allow documentation tobe built for other formats than tex and info sh@sh-laptop parents: 7017 diff changeset	62 ## @end ifnottex
3426 f8dde1807dee [project @ 2000-01-13 08:40:00 by jwe] jwe parents: 3321 diff changeset	63 ##
19040 0850b5212619 doc: Add @nospell macro around proper names in documentation. Rik <rik@octave.org> parents: 17744 diff changeset	64 ## See @nospell{Magnus and Neudecker} (1988), @cite{Matrix Differential
27800 5a6a19a4e3da doc: Use Texinfo non-sentence ending periods in citations. Rik <rik@octave.org> parents: 26376 diff changeset	65 ## Calculus with Applications in Statistics and Econometrics}.
3321 6923abb04e16 [project @ 1999-10-26 18:15:30 by jwe] jwe parents: 2540 diff changeset	66 ## @end deftypefn
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	67
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	68 function d = duplication_matrix (n)
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	69
28891 de5f2f9a64ff maint: Use same coding style when checking for a minimum of 1 input. Rik <rik@octave.org> parents: 28886 diff changeset	70 if (nargin < 1)
6046 34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe] jwe parents: 5428 diff changeset	71 print_usage ();
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	72 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	73
13286 49ae6f497171 Use common code idiom x == fix (x) to detect integers Rik <octave@nomad.inbox5.com> parents: 13085 diff changeset	74 if (! (isscalar (n) && n > 0 && n == fix (n)))
11472 1740012184f9 Use uppercase for variable names in error() strings to match Info documentation. Only m-files done. Rik <octave@nomad.inbox5.com> parents: 9211 diff changeset	75 error ("duplication_matrix: N must be a positive integer");
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	76 endif
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	77
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	78 d = zeros (n * n, n * (n + 1) / 2);
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	79
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	80 ## It is clearly possible to make this a LOT faster!
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	81 count = 0;
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	82 for j = 1 : n
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	83 d((j - 1) * n + j, count + j) = 1;
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	84 for i = (j + 1) : n
19833 9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	85 d((j - 1) * n + i, count + i) = 1;
9fc020886ae9 maint: Clean up m-files to follow Octave coding conventions. Rik <rik@octave.org> parents: 19697 diff changeset	86 d((i - 1) * n + j, count + i) = 1;
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	87 endfor
20231 83792dd9bcc1 Use in-place operators in m-files where possible. Rik <rik@octave.org> parents: 20160 diff changeset	88 count += n - j;
2540 c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	89 endfor
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	90
c3d634d49ce4 [project @ 1996-11-20 00:20:12 by jwe] jwe parents: diff changeset	91 endfunction
13084 60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	92
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	93
13085 0fe1b5d4db56 codesprint: Fix typo Jordi Gutiérrez Hermoso <jordigh@gmail.com> parents: 13084 diff changeset	94 %!test
13084 60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	95 %! N = 2;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	96 %! A = rand (N);
13084 60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	97 %! B = A * A';
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	98 %! C = A + A';
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	99 %! D = duplication_matrix (N);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	100 %! assert (D * vech (B), vec (B), 1e-6);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	101 %! assert (D * vech (C), vec (C), 1e-6);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	102
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	103 %!test
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	104 %! N = 3;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	105 %! A = rand (N);
13084 60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	106 %! B = A * A';
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	107 %! C = A + A';
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	108 %! D = duplication_matrix (N);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	109 %! assert (D * vech (B), vec (B), 1e-6);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	110 %! assert (D * vech (C), vec (C), 1e-6);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	111
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	112 %!test
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	113 %! N = 4;
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	114 %! A = rand (N);
13084 60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	115 %! B = A * A';
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	116 %! C = A + A';
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	117 %! D = duplication_matrix (N);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	118 %! assert (D * vech (B), vec (B), 1e-6);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	119 %! assert (D * vech (C), vec (C), 1e-6);
60bd7ebb12fc codesprint: 7 tests for duplication_matrix.m Andriy Shinkarchuck <adriano32.gnu@gmail.com> parents: 11523 diff changeset	120
28886 d8318c12d903 test: remove unnecessary BIST tests in m-files checking for excessive number of inputs. Rik <rik@octave.org> parents: 27984 diff changeset	121 %!error <Invalid call> duplication_matrix ()
14363 f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	122 %!error duplication_matrix (0.5)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	123 %!error duplication_matrix (-1)
f3d52523cde1 Use Octave coding conventions in all m-file %!test blocks Rik <octave@nomad.inbox5.com> parents: 14138 diff changeset	124 %!error duplication_matrix (ones (1,4))

Mercurial > octave

annotate scripts/linear-algebra/duplication_matrix.m @ 33634:4a70f390c85e default tip @