Mercurial > hg > octave-nkf

annotate scripts/sparse/sprandn.m @ 18725:54a1e95365e1

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Overhaul sprand, sprandn functions. * __sprand_impl__: Rename variable "funname" to "fcnname". Add comments to Reciprocal Condition number calculation. Rename "mynnz" to "k" to match rest of code. Add input validation test that RC is scalar or vector. Use double quotes instead of single quotes per Octave guidelines. Check for special case of output vector to avoid problems. Use randperm to replace do/until loop for speed. Pre-calculate speye() value instead of doing per loop iteration. * sprand.m: Improve docstring. Match function output variable name to documentation. Add check string to %!error tests. * sprandn.m: Improve docstring. Match function output variable name to documentation. Add check string to %!error tests.
author Rik <rik@octave.org>
date Sun, 23 Mar 2014 20:35:22 -0700
parents 35a5e7740a6d
children c53e11fab75f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
17744
d63878346099 maint: Update copyright notices for release.
John W. Eaton <jwe@octave.org>
parents: 17338
diff changeset
1 ## Copyright (C) 2004-2013 Paul Kienzle
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
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.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
4 ##
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.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
14 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
15 ## You should have received a copy of the GNU General Public License
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/>.
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
18 ##
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
19 ## Original version by Paul Kienzle distributed as free software in the
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe]
jwe
parents: 6498
diff changeset
20 ## public domain.
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
21
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
22 ## -*- texinfo -*-
10793
be55736a0783 Grammarcheck the documentation from m-files.
Rik <octave@nomad.inbox5.com>
parents: 9245
diff changeset
23 ## @deftypefn {Function File} {} sprandn (@var{m}, @var{n}, @var{d})
18724
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
24 ## @deftypefnx {Function File} {} sprandn (@var{m}, @var{n}, @var{d}, @var{rc})
5610
9761b7d24e9e [project @ 2006-02-09 09:12:02 by dbateman]
dbateman
parents: 5164
diff changeset
25 ## @deftypefnx {Function File} {} sprandn (@var{s})
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
26 ## Generate a sparse matrix with normally distributed random values.
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
27 ##
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
28 ## The size of the matrix is @var{m}x@var{n} with a density of values @var{d}.
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
29 ## @var{d} must be between 0 and 1. Values will be normally distributed with a
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
30 ## mean of 0 and a variance of 1.
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
31 ##
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
32 ## If called with a single matrix argument, a sparse matrix is generated with
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
33 ## random values wherever the matrix @var{s} is non-zero.
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
34 ##
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
35 ## If called with a scalar fourth argument @var{rc}, a random sparse matrix
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
36 ## with reciprocal condition number @var{rc} is generated. If @var{rc} is
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
37 ## a vector, then it specifies the first singular values of the generated
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
38 ## matrix (@code{length (@var{rc}) <= min (@var{m}, @var{n})}).
18724
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
39 ##
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
40 ## @seealso{sprand, sprandsym, randn}
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
41 ## @end deftypefn
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
42
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
43 ## Author: Paul Kienzle <pkienzle@users.sf.net>
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
44
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
45 function s = sprandn (m, n, d, rc)
6498
2c85044aa63f [project @ 2007-04-05 17:59:47 by jwe]
jwe
parents: 6046
diff changeset
46
13197
6db186dfdeaa Refactor sprandn/sprand code, move common code to common function (bug #34352)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13064
diff changeset
47 if (nargin == 1 )
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
48 s = __sprand_impl__ (m, @randn);
13197
6db186dfdeaa Refactor sprandn/sprand code, move common code to common function (bug #34352)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13064
diff changeset
49 elseif ( nargin == 3)
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
50 s = __sprand_impl__ (m, n, d, "sprandn", @randn);
18724
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
51 elseif (nargin == 4)
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
52 s = __sprand_impl__ (m, n, d, rc, "sprandn", @randn);
13197
6db186dfdeaa Refactor sprandn/sprand code, move common code to common function (bug #34352)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13064
diff changeset
53 else
6046
34f96dd5441b [project @ 2006-10-10 16:10:25 by jwe]
jwe
parents: 5642
diff changeset
54 print_usage ();
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
55 endif
13058
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
56
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
57 endfunction
13058
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
58
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
59
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
60 %% Test 3-input calling form
13058
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
61 %!test
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
62 %! s = sprandn (4, 10, 0.1);
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
63 %! assert (size (s), [4, 10]);
13197
6db186dfdeaa Refactor sprandn/sprand code, move common code to common function (bug #34352)
Jordi Gutiérrez Hermoso <jordigh@octave.org>
parents: 13064
diff changeset
64 %! assert (nnz (s) / numel (s), 0.1);
13058
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
65
18724
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
66 %% Test 4-input calling form
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
67 %!test
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
68 %! d = rand ();
18724
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
69 %! s1 = sprandn (100, 100, d, 0.4);
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
70 %! rc = [5, 4, 3, 2, 1, 0.1];
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
71 %! s2 = sprandn (100, 100, d, rc);
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
72 %! s3 = sprandn (6, 4, d, rc);
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
73 %! assert (svd (s2)'(1:length (rc)), rc, sqrt (eps));
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
74 %! assert (1/cond (s1), 0.4, sqrt (eps));
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
75 %! assert (nnz (s1) / (100*100), d, 0.02);
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
76 %! assert (nnz (s2) / (100*100), d, 0.02);
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
77 %! assert (svd (s3)', [5 4 3 2], sqrt (eps));
35a5e7740a6d Added implementation for 4th argument of sprand/sprandn (bug #41839).
Eduardo Ramos (edu159) <eduradical951@gmail.com>
parents: 17744
diff changeset
78
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
79 %% Test 1-input calling form
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
80 %!test
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
81 %! s = sprandn (sparse ([1 2 3], [3 2 3], [2 2 2]));
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
82 %! [i, j] = find (s);
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
83 %! assert (sort (i), [1 2 3]');
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
84 %! assert (sort (j), [2 3 3]');
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
85
13058
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
86 %% Test input validation
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
87 %!error sprandn ()
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
88 %!error sprandn (1, 2)
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
89 %!error sprandn (1, 2, 3, 4)
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
90 %!error <M must be an integer greater than 0> sprandn (ones (3), 3, 0.5)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
91 %!error <M must be an integer greater than 0> sprandn (3.5, 3, 0.5)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
92 %!error <M must be an integer greater than 0> sprandn (0, 3, 0.5)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
93 %!error <N must be an integer greater than 0> sprandn (3, ones (3), 0.5)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
94 %!error <N must be an integer greater than 0> sprandn (3, 3.5, 0.5)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
95 %!error <N must be an integer greater than 0> sprandn (3, 0, 0.5)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
96 %!error <D must be between 0 and 1> sprandn (3, 3, -1)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
97 %!error <D must be between 0 and 1> sprandn (3, 3, 2)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
98 %!error <RC must be a scalar or vector> sprandn (2, 2, 0.2, ones (3,3))
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
99 %!error <RC must be between 0 and 1> sprandn (2, 2, 0.2, -1)
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
100 %!error <RC must be between 0 and 1> sprandn (2, 2, 0.2, 2)
13058
14422cc782b2 codesprint: Write input validation and tests for sprandn.m
Rik <octave@nomad.inbox5.com>
parents: 11587
diff changeset
101
16779
8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376)
David Bateman <dbateman@free.fr>
parents: 14868
diff changeset
102 %% Test very large, very low density matrix doesn't fail
8fce0ed4894a Specialize is_empty and numel methods for sparse matrices (debian bug #706376)
David Bateman <dbateman@free.fr>
parents: 14868
diff changeset
103 %!test
18725
54a1e95365e1 Overhaul sprand, sprandn functions.
Rik <rik@octave.org>
parents: 18724
diff changeset
104 %! s = sprandn (1e6,1e6,1e-7);
17338
1c89599167a6 maint: End m-files with 1 blank line.
Rik <rik@octave.org>
parents: 16779
diff changeset
105