annotate scripts/sparse/sprandsym.m @ 6252:738c97e101eb

[project @ 2007-01-24 19:58:46 by jwe]
author jwe
date Wed, 24 Jan 2007 19:58:46 +0000
parents 34f96dd5441b
children 2c85044aa63f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
1 ## Copyright (C) 2004 David Bateman & Andy Adler
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
2 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
3 ## This program is free software; you can redistribute it and/or modify
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
4 ## it under the terms of the GNU General Public License as published by
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
5 ## the Free Software Foundation; either version 2 of the License, or
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
6 ## (at your option) any later version.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
7 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
8 ## This program is distributed in the hope that it will be useful,
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
9 ## but WITHOUT ANY WARRANTY; without even the implied warranty of
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
10 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
11 ## GNU General Public License for more details.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
12 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
13 ## You should have received a copy of the GNU General Public License
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
14 ## along with this program; if not, write to the Free Software
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
15 ## Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
16 ## 02110-1301 USA
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
17
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
18 ## -*- texinfo -*-
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
19 ## @deftypefn {Function File} {} sprandsym (@var{n}, @var{d})
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
20 ## @deftypefnx {Function File} {} sprandsym (@var{s})
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
21 ## 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
22 ## @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
23 ## @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
24 ## distributed with mean of zero and variance 1.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
25 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
26 ## 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
27 ## This is unlikely to happen for large really sparse matrices.
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
28 ##
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
29 ## 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
30 ## 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
31 ## triangular part.
5642
2618a0750ae6 [project @ 2006-03-06 21:26:48 by jwe]
jwe
parents: 5610
diff changeset
32 ## @seealso{sprand, sprandn}
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
33 ## @end deftypefn
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
34
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
35 function S = sprandsym (n, d)
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
36 if (nargin == 1)
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
37 [i, j, v, nr, nc] = spfind (tril (n));
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
38 S = sparse (i, j, randn (size (v)), nr, nc);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
39 S = S + tril (S, -1)';
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
40 elseif (nargin == 2)
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
41 m1 = floor (n/2);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
42 n1 = m1 + rem (n, 2);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
43 mn1 = m1*n1;
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
44 k1 = round (d*mn1);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
45 idx1 = unique (fix(rand(min(k1*1.01,k1+10),1)*mn1))+1;
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
46 ## 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
47 ## 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
48 ## 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
49 ## strategy could be used but I don't think it's worth the price.
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
50 k1 = min (length (idx1), k1); # actual number of entries in S
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
51 j1 = floor ((idx1(1:k1)-1)/m1);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
52 i1 = idx1(1:k1) - j1*m1;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
53
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
54 n2 = ceil (n/2);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
55 nn2 = n2*n2;
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
56 k2 = round (d*nn2);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
57 idx2 = unique (fix (rand (min (k2*1.01, k1+10), 1)*nn2)) + 1;
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
58 k2 = min (length (idx2), k2);
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
59 j2 = floor ((idx2(1:k2)-1)/n2);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
60 i2 = idx2(1:k2) - j2*n2;
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
61
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
62 if (isempty (i1) && isempty (i2))
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
63 S = sparse (n, n);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
64 else
6252
738c97e101eb [project @ 2007-01-24 19:58:46 by jwe]
jwe
parents: 6046
diff changeset
65 S1 = sparse (i1, j1+1, randn (k1, 1), m1, n1);
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
66 S = [tril(S1), sparse(m1,m1); ...
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
67 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
68 S = S + tril (S, -1)';
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
69 endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
70 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
71 print_usage ();
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
72 endif
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents:
diff changeset
73 endfunction