annotate scripts/sparse/sprandsym.m @ 8920:eb63fbe60fab

update copyright notices
author John W. Eaton <jwe@octave.org>
date Sat, 07 Mar 2009 10:41:27 -0500
parents bc982528de11
children 1bf0ce0930be
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: 8506
diff changeset
1 ## Copyright (C) 2004, 2006, 2007, 2008, 2009 David Bateman & Andy Adler
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
2 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
3 ## This file is part of Octave.
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
4 ##
7016
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
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: 6498
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: 6498
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: 6498
diff changeset
8 ## your option) any later version.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
9 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
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: 6498
diff changeset
11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
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: 6498
diff changeset
13 ## General Public License for more details.
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
14 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
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: 6498
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: 6498
diff changeset
17 ## <http://www.gnu.org/licenses/>.
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
18
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
19 ## -*- texinfo -*-
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefn {Function File} {} sprandsym (@var{n}, @var{d})
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
21 ## @deftypefnx {Function File} {} sprandsym (@var{s})
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
22 ## Generate a symmetric random sparse matrix. The size of the matrix will be
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
23 ## @var{n} by @var{n}, with a density of values given by @var{d}.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
24 ## @var{d} should be between 0 and 1. Values will be normally
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
25 ## distributed with mean of zero and variance 1.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
26 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
27 ## Note: sometimes the actual density may be a bit smaller than @var{d}.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
28 ## This is unlikely to happen for large really sparse matrices.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
29 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
30 ## If called with a single matrix argument, a random sparse matrix is
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
31 ## generated wherever the matrix @var{S} is non-zero in its lower
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
32 ## triangular part.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5610
diff changeset
33 ## @seealso{sprand, sprandn}
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
34 ## @end deftypefn
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
35
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
36 function S = sprandsym (n, d)
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
37 if (nargin == 1)
7505
f5005d9510f4 Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
38 [i, j, v] = find (tril (n));
f5005d9510f4 Remove dispatched sparse functions and treat in the generic versions of the functions
David Bateman <dbateman@free.fr>
parents: 7017
diff changeset
39 [nr, nc] = size (n);
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
40 S = sparse (i, j, randn (size (v)), nr, nc);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
41 S = S + tril (S, -1)';
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
42 elseif (nargin == 2)
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
43 m1 = floor (n/2);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
44 n1 = m1 + rem (n, 2);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
45 mn1 = m1*n1;
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
46 k1 = round (d*mn1);
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6252
diff changeset
47 idx1 = unique (fix (rand (min (k1*1.01, k1+10), 1) * mn1)) + 1;
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
48 ## idx contains random numbers in [1,mn] generate 1% or 10 more
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
49 ## random values than necessary in order to reduce the probability
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
50 ## that there are less than k distinct values; maybe a better
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
51 ## strategy could be used but I don't think it's worth the price.
8506
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
52
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
53 ## Actual number of entries in S.
bc982528de11 comment style fixes
John W. Eaton <jwe@octave.org>
parents: 7505
diff changeset
54 k1 = min (length (idx1), k1);
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
55 j1 = floor ((idx1(1:k1)-1)/m1);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
56 i1 = idx1(1:k1) - j1*m1;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
57
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
58 n2 = ceil (n/2);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
59 nn2 = n2*n2;
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
60 k2 = round (d*nn2);
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6252
diff changeset
61 idx2 = unique (fix (rand (min (k2*1.01, k1+10), 1) * nn2)) + 1;
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
62 k2 = min (length (idx2), k2);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
63 j2 = floor ((idx2(1:k2)-1)/n2);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
64 i2 = idx2(1:k2) - j2*n2;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
65
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
66 if (isempty (i1) && isempty (i2))
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
67 S = sparse (n, n);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
68 else
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
69 S1 = sparse (i1, j1+1, randn (k1, 1), m1, n1);
7017
a1dbe9d80eee [project @ 2007-10-12 21:27:11 by jwe]
jwe
parents: 7016
diff changeset
70 S = [tril(S1), sparse(m1,m1); ...
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
71 sparse(i2,j2+1,randn(k2,1),n2,n2), triu(S1,1)'];
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
72 S = S + tril (S, -1)';
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
73 endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
74 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
75 print_usage ();
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
76 endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
77 endfunction