Mercurial > octave

annotate libinterp/corefcn/sparse.cc @ 30801:568bddf0215e

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
deprecate sparse_auto_mutate function and internal variable * sparse.cc (Fsparse): Don't set Vsparse_auto_mutate to false. * ov-base.h, ov-base.cc (Vsparse_auto_mutate): Deprecate variable. (Fsparse_auto_mutate): Delete function and tests. * ov-bool-sparse.h, ov-bool-sparse.cc (octave_sparse_bool_matrix::try_narrowing_conversion): Delete. * ov-re-sparse.h, ov-re-sparse.cc (octave_sparse_bool_matrix::try_narrowing_conversion): Delete. * ov-cx-sparse.cc (octave_sparse_complex_matrix::try_narrowing_conversion): Only perform complex sparse -> real sparse conversion. * scripts/deprecated/sparse_auto_mutate.m: New function. * scripts/deprecated/module.mk: Update. * sparse.txi: Remove documentation for sparse_auto_mutate.
author John W. Eaton <jwe@octave.org>
date Wed, 02 Mar 2022 15:01:30 -0500
parents 83f9f8bda883
children e88a07dec498
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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 //
30564
796f54d4ddbf update Octave Project Developers copyright for the new year
John W. Eaton <jwe@octave.org>
parents: 30390
diff changeset
3 // Copyright (C) 1998-2022 The Octave Project Developers
27923
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
4 //
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/>.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
7 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
8 // This file is part of Octave.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
9 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
10 // Octave is free software: you can redistribute it and/or modify it
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
11 // under the terms of the GNU General Public License as published by
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
12 // the Free Software Foundation, either version 3 of the License, or
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
13 // (at your option) any later version.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
14 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
15 // Octave is distributed in the hope that it will be useful, but
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
16 // WITHOUT ANY WARRANTY; without even the implied warranty of
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
17 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
18 // GNU General Public License for more details.
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
19 //
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
20 // You should have received a copy of the GNU General Public License
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
21 // along with Octave; see the file COPYING. If not, see
bd51beb6205e update formatting of copyright notices
John W. Eaton <jwe@octave.org>
parents: 27919
diff changeset
22 // <https://www.gnu.org/licenses/>.
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 ////////////////////////////////////////////////////////////////////////
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
25
21724
aba2e6293dd8 use "#if ..." consistently instead of "#ifdef" and "#ifndef"
John W. Eaton <jwe@octave.org>
parents: 21547
diff changeset
26 #if defined (HAVE_CONFIG_H)
21301
40de9f8f23a6 Use '#include "config.h"' rather than <config.h>.
Rik <rik@octave.org>
parents: 21200
diff changeset
27 # include "config.h"
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
28 #endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
29
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
30 #include <cstdlib>
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
31 #include <string>
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
32
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
33 #include "variables.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
34 #include "utils.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
35 #include "pager.h"
11097
ffb2f1ef2097 make issparse, sparse, and spalloc built-in functions
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
36 #include "defun.h"
21100
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents: 21062
diff changeset
37 #include "errwarn.h"
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
38 #include "quit.h"
10479
ded9beac7582 optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents: 10155
diff changeset
39 #include "unwind-prot.h"
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
40
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
41 #include "ov-re-sparse.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
42 #include "ov-cx-sparse.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
43 #include "ov-bool-sparse.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
44
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29569
diff changeset
45 OCTAVE_NAMESPACE_BEGIN
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29569
diff changeset
46
11097
ffb2f1ef2097 make issparse, sparse, and spalloc built-in functions
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
47 DEFUN (issparse, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
48 doc: /* -*- texinfo -*-
30559
841a10208c38 doc: Use TF for output variable in documentation for isXXX functions in libinterp/ directory.
Rik <rik@octave.org>
parents: 30390
diff changeset
49 @deftypefn {} {@var{tf} =} issparse (@var{x})
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
50 Return true if @var{x} is a sparse matrix.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
51 @seealso{ismatrix}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
52 @end deftypefn */)
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
53 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
54 if (args.length () != 1)
20803
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
55 print_usage ();
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
56
23583
b7747a2c88b2 maint: Deprecate is_sparse_type and replace with issparse.
Rik <rik@octave.org>
parents: 23581
diff changeset
57 return ovl (args(0).issparse ());
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
58 }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
59
26213
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
60 /*
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
61 %!assert (issparse (sparse (1)), true)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
62 %!assert (issparse (1), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
63 %!assert (issparse (sparse (false)), true)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
64 %!assert (issparse (true), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
65 %!assert (issparse (sparse (single ([1 2]))), true)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
66 %!assert (issparse (single ([1, 2])), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
67 %!assert (issparse (sparse ([1+i, 2]')), true)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
68 %!assert (issparse ([1+i, 2]'), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
69
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
70 %!assert (issparse ([]), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
71 %!assert (issparse (sparse([])), true)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
72 %!assert (issparse ("test"), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
73 %!assert (issparse (struct ("one", {1})), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
74 %!assert (issparse (cell (1)), false)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
75
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
76 ## Test input validation
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
77 %!error issparse ()
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
78 %!error issparse (1,2)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
79 */
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
80
11097
ffb2f1ef2097 make issparse, sparse, and spalloc built-in functions
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
81 DEFUN (sparse, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
82 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
83 @deftypefn {} {@var{s} =} sparse (@var{a})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
84 @deftypefnx {} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
85 @deftypefnx {} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
86 @deftypefnx {} {@var{s} =} sparse (@var{m}, @var{n})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
87 @deftypefnx {} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, "unique")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
88 @deftypefnx {} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
89 Create a sparse matrix from a full matrix, or row, column, value triplets.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
90
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
91 If @var{a} is a full matrix, convert it to a sparse matrix representation,
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
92 removing all zero values in the process.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
93
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
94 Given the integer index vectors @var{i} and @var{j}, and a 1-by-@code{nnz}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
95 vector of real or complex values @var{sv}, construct the sparse matrix
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
96 @code{S(@var{i}(@var{k}),@var{j}(@var{k})) = @var{sv}(@var{k})} with overall
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
97 dimensions @var{m} and @var{n}. If any of @var{sv}, @var{i} or @var{j} are
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
98 scalars, they are expanded to have a common size.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
99
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
100 If @var{m} or @var{n} are not specified their values are derived from the
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
101 maximum index in the vectors @var{i} and @var{j} as given by
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
102 @code{@var{m} = max (@var{i})}, @code{@var{n} = max (@var{j})}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
103
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
104 @strong{Note}: if multiple values are specified with the same @var{i},
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
105 @var{j} indices, the corresponding value in @var{s} will be the sum of the
28960
e5a1087f15d5 doc: Use @xref, @pxref rather than "see @code{}" in TexInfo in libinterp/
Rik <rik@octave.org>
parents: 28907
diff changeset
106 values at the repeated location. @xref{XREFaccumarray,,@code{accumarray}}, for
e5a1087f15d5 doc: Use @xref, @pxref rather than "see @code{}" in TexInfo in libinterp/
Rik <rik@octave.org>
parents: 28907
diff changeset
107 an example of how to produce different behavior such as taking the minimum
e5a1087f15d5 doc: Use @xref, @pxref rather than "see @code{}" in TexInfo in libinterp/
Rik <rik@octave.org>
parents: 28907
diff changeset
108 instead.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
109
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
110 If the option @qcode{"unique"} is given, and more than one value is
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
111 specified at the same @var{i}, @var{j} indices, then the last specified
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
112 value will be used.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
113
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
114 @code{sparse (@var{m}, @var{n})} will create an empty @var{m}x@var{n} sparse
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
115 matrix and is equivalent to @code{sparse ([], [], [], @var{m}, @var{n})}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
116
25472
9771111f04f4 doc: Use @var rather than @code to mark inputs to functions in docstrings.
Rik <rik@octave.org>
parents: 25054
diff changeset
117 The argument @var{nzmax} is ignored but accepted for compatibility with
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
118 @sc{matlab}.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
119
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
120 Example 1 (sum at repeated indices):
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
121
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
122 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
123 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
124 @var{i} = [1 1 2]; @var{j} = [1 1 2]; @var{sv} = [3 4 5];
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
125 sparse (@var{i}, @var{j}, @var{sv}, 3, 4)
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
126 @result{}
26600
f6730533820e doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents: 26376
diff changeset
127 Compressed Column Sparse (rows = 3, cols = 4, nnz = 2 [17%])
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
128
26600
f6730533820e doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents: 26376
diff changeset
129 (1, 1) -> 7
f6730533820e doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents: 26376
diff changeset
130 (2, 2) -> 5
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
131 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
132 @end example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
133
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
134 Example 2 ("unique" option):
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
135
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
136 @example
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
137 @group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
138 @var{i} = [1 1 2]; @var{j} = [1 1 2]; @var{sv} = [3 4 5];
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
139 sparse (@var{i}, @var{j}, @var{sv}, 3, 4, "unique")
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
140 @result{}
26600
f6730533820e doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents: 26376
diff changeset
141 Compressed Column Sparse (rows = 3, cols = 4, nnz = 2 [17%])
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
142
26600
f6730533820e doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents: 26376
diff changeset
143 (1, 1) -> 4
f6730533820e doc: clean up doc example blocks for accuracy and consistent formatting
Mike Miller <mtmiller@octave.org>
parents: 26376
diff changeset
144 (2, 2) -> 5
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
145 @end group
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
146 @end example
30329
81d26e8481a6 maint: Shorten @seealso lines to less than 80 characters (bug #57599)
Rik <rik@octave.org>
parents: 29961
diff changeset
147 @seealso{full, accumarray, spalloc, spdiags, speye, spones, sprand, sprandn,
81d26e8481a6 maint: Shorten @seealso lines to less than 80 characters (bug #57599)
Rik <rik@octave.org>
parents: 29961
diff changeset
148 sprandsym, spconvert, spfun}
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
149 @end deftypefn */)
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
150 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
151 int nargin = args.length ();
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
152
20803
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
153 if (nargin == 0 || nargin > 6)
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
154 print_usage ();
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
155
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
156 octave_value retval;
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
157
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
158 if (nargin == 1)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
159 {
18112
b560bac0fca2 maint: Don't use space between 'args' and '(' when doing indexing.
Rik <rik@octave.org>
parents: 18100
diff changeset
160 octave_value arg = args(0);
23579
c20a0fa91c0c maint: Deprecate is_bool_type and replace with islogical.
Rik <rik@octave.org>
parents: 23220
diff changeset
161 if (arg.islogical ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
162 retval = arg.sparse_bool_matrix_value ();
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23579
diff changeset
163 else if (arg.iscomplex ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
164 retval = arg.sparse_complex_matrix_value ();
23586
f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric.
Rik <rik@octave.org>
parents: 23583
diff changeset
165 else if (arg.isnumeric ())
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
166 retval = arg.sparse_matrix_value ();
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
167 else
21100
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents: 21062
diff changeset
168 err_wrong_type_arg ("sparse", arg);
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
169 }
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
170 else if (nargin == 2)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
171 {
18454
0821a51a9e1b allow sparse arguments for dimensions in sparse function (bug #41535)
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
172 octave_idx_type m = 0;
0821a51a9e1b allow sparse arguments for dimensions in sparse function (bug #41535)
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
173 octave_idx_type n = 0;
0821a51a9e1b allow sparse arguments for dimensions in sparse function (bug #41535)
John W. Eaton <jwe@octave.org>
parents: 17787
diff changeset
174
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
175 get_dimensions (args(0), args(1), "sparse", m, n);
10479
ded9beac7582 optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents: 10155
diff changeset
176
26213
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
177 if (m < 0 || n < 0)
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
178 error ("sparse: dimensions must be non-negative");
26213
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
179
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
180 retval = SparseMatrix (m, n);
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
181 }
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
182 else if (nargin >= 3)
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
183 {
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
184 bool summation = true;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
185 if (nargin > 3 && args(nargin-1).is_string ())
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
186 {
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
187 std::string opt = args(nargin-1).string_value ();
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
188 if (opt == "unique")
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
189 summation = false;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
190 else if (opt == "sum" || opt == "summation")
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
191 summation = true;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
192 else
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
193 error ("sparse: invalid option: %s", opt.c_str ());
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
194
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
195 nargin -= 1;
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
196 }
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
197
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
198 octave_idx_type m, n, nzmax;
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
199 m = n = nzmax = -1;
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
200 if (nargin == 6)
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
201 {
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
202 nzmax = args(5).idx_type_value ();
21062
d9c1884d1aaa maint: Eliminate space between variable and decrement '--' operator.
Rik <rik@octave.org>
parents: 20939
diff changeset
203 nargin--;
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
204 }
10527
b4d2080b6df7 Replace nzmax by nnz as needed
David Bateman <dbateman@free.fr>
parents: 10521
diff changeset
205
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
206 if (nargin == 5)
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
207 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
208 get_dimensions (args(3), args(4), "sparse", m, n);
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
209
20667
8742e0b1cc49 eliminate more uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20555
diff changeset
210 if (m < 0 || n < 0)
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
211 error ("sparse: dimensions must be non-negative");
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
212 }
10479
ded9beac7582 optimize sparse matrix assembly
Jaroslav Hajek <highegg@gmail.com>
parents: 10155
diff changeset
213
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
214 int k = 0; // index we're checking when index_vector throws
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
215 try
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
216 {
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
217 idx_vector i = args(0).index_vector ();
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
218 k = 1;
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
219 idx_vector j = args(1).index_vector ();
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
220
23579
c20a0fa91c0c maint: Deprecate is_bool_type and replace with islogical.
Rik <rik@octave.org>
parents: 23220
diff changeset
221 if (args(2).islogical ())
30390
a61e1a0f6024 maint: style check C++ files in libinterp/ ahead of 7.1 release.
Rik <rik@octave.org>
parents: 30329
diff changeset
222 retval = SparseBoolMatrix (args(2).bool_array_value (), i, j,
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
223 m, n, summation, nzmax);
23581
c3075ae020e1 maint: Deprecate is_complex_type and replace with iscomplex.
Rik <rik@octave.org>
parents: 23579
diff changeset
224 else if (args(2).iscomplex ())
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
225 retval = SparseComplexMatrix (args(2).complex_array_value(),
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
226 i, j, m, n, summation, nzmax);
23586
f6c5db0a02e7 maint: Deprecate is_numeric_type and replace with isnumeric.
Rik <rik@octave.org>
parents: 23583
diff changeset
227 else if (args(2).isnumeric ())
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
228 retval = SparseMatrix (args(2).array_value (), i, j,
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
229 m, n, summation, nzmax);
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
230 else
21100
e39e05d90788 Switch gripe_XXX to either err_XXX or warn_XXX naming scheme.
Rik <rik@octave.org>
parents: 21062
diff changeset
231 err_wrong_type_arg ("sparse", args(2));
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
232 }
29961
7d6709900da7 eliminate octave:: namespace tags in DEFUN and DEFMETHOD and more
John W. Eaton <jwe@octave.org>
parents: 29958
diff changeset
233 catch (index_exception& ie)
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
234 {
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
235 // Rethrow to allow more info to be reported later.
29163
8f67ad8b3103 maint: Updating naming conventions for exceptions and use const where possible.
Rik <rik@octave.org>
parents: 28960
diff changeset
236 ie.set_pos_if_unset (2, k+1);
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
237 throw;
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
238 }
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
239 }
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
240
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
241 return retval;
5164
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe]
jwe
parents:
diff changeset
242 }
10513
c5005bc2b7a9 implement working spalloc
Jaroslav Hajek <highegg@gmail.com>
parents: 10479
diff changeset
243
26213
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
244 /*
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
245 ## Tests for sparse constructor are in test/sparse.tst
28907
11f1207111c5 maint: Don't use semicolon at end of single-line BIST tests.
Rik <rik@octave.org>
parents: 28888
diff changeset
246 %!assert (1)
26213
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
247 */
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
248
11097
ffb2f1ef2097 make issparse, sparse, and spalloc built-in functions
John W. Eaton <jwe@octave.org>
parents: 10846
diff changeset
249 DEFUN (spalloc, args, ,
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
250 doc: /* -*- texinfo -*-
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
251 @deftypefn {} {@var{s} =} spalloc (@var{m}, @var{n}, @var{nz})
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
252 Create an @var{m}-by-@var{n} sparse matrix with pre-allocated space for at
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
253 most @var{nz} nonzero elements.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
254
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
255 This is useful for building a matrix incrementally by a sequence of indexed
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
256 assignments. Subsequent indexed assignments after @code{spalloc} will reuse
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
257 the pre-allocated memory, provided they are of one of the simple forms
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
258
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
259 @itemize
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
260 @item @code{@var{s}(I:J) = @var{x}}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
261
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
262 @item @code{@var{s}(:,I:J) = @var{x}}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
263
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
264 @item @code{@var{s}(K:L,I:J) = @var{x}}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
265 @end itemize
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
266
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
267 @b{and} that the following conditions are met:
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
268
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
269 @itemize
27081
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26600
diff changeset
270 @item the assignment does not decrease @code{nnz (@var{S})}.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
271
27081
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26600
diff changeset
272 @item after the assignment, @code{nnz (@var{S})} does not exceed @var{nz}.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
273
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
274 @item no index is out of bounds.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
275 @end itemize
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
276
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
277 Partial movement of data may still occur, but in general the assignment will
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
278 be more memory and time efficient under these circumstances. In particular,
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
279 it is possible to efficiently build a pre-allocated sparse matrix from a
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
280 contiguous block of columns.
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
281
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
282 The amount of pre-allocated memory for a given matrix may be queried using
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
283 the function @code{nzmax}.
27081
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26600
diff changeset
284
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26600
diff changeset
285 Programming Note: Octave always reserves memory for at least one value,
c0d8ce61c1c9 Always reserve at least 1 element of storage for sparse matrices (bug #56232).
Rik <rik@octave.org>
parents: 26600
diff changeset
286 even if @var{nz} is 0.
21966
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
287 @seealso{nzmax, sparse}
112b20240c87 move docstrings in C++ files out of C strings and into comments
John W. Eaton <jwe@octave.org>
parents: 21743
diff changeset
288 @end deftypefn */)
10513
c5005bc2b7a9 implement working spalloc
Jaroslav Hajek <highegg@gmail.com>
parents: 10479
diff changeset
289 {
17787
175b392e91fe Use GNU style coding conventions for code in libinterp/
Rik <rik@octave.org>
parents: 17744
diff changeset
290 int nargin = args.length ();
10513
c5005bc2b7a9 implement working spalloc
Jaroslav Hajek <highegg@gmail.com>
parents: 10479
diff changeset
291
20803
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
292 if (nargin < 2 || nargin > 3)
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
293 print_usage ();
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
294
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
295 octave_idx_type m = args(0).idx_type_value ();
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
296 octave_idx_type n = args(1).idx_type_value ();
20939
b17fda023ca6 maint: Use new C++ archetype in more files.
Rik <rik@octave.org>
parents: 20853
diff changeset
297
20803
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
298 octave_idx_type nz = 0;
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
299 if (nargin == 3)
c22206c1a88f eliminate return statements after calls to print_usage
John W. Eaton <jwe@octave.org>
parents: 20667
diff changeset
300 nz = args(2).idx_type_value ();
20555
f90c8372b7ba eliminate many more simple uses of error_state
John W. Eaton <jwe@octave.org>
parents: 20542
diff changeset
301
26213
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
302 if (m < 0 || n < 0 || nz < 0)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
303 error ("spalloc: M, N, and NZ must be non-negative");
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
304
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
305 return ovl (SparseMatrix (dim_vector (m, n), nz));
10513
c5005bc2b7a9 implement working spalloc
Jaroslav Hajek <highegg@gmail.com>
parents: 10479
diff changeset
306 }
26213
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
307
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
308 /*
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
309 %!assert (issparse (spalloc (1,1)))
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
310 %!assert (spalloc (1,1), sparse (1,1))
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
311 %!test
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
312 %! s = spalloc (1,1,5);
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
313 %! assert (s, sparse (1,1));
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
314 %! assert (nzmax (s), 5);
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
315 %!assert (spalloc (1,2), sparse (1,2))
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
316 %!assert (spalloc (1,2,2), sparse (1,2))
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
317 %!assert (spalloc (2,1), sparse (2,1))
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
318 %!assert (spalloc (2,1,2), sparse (2,1))
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
319
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
320 %!error spalloc ()
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
321 %!error spalloc (1)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
322 %!error spalloc (1,2,3,4)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
323 %!error <M, N, and NZ must be non-negative> spalloc (-1, 1, 1)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
324 %!error <M, N, and NZ must be non-negative> spalloc (1, -1, 1)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
325 %!error <M, N, and NZ must be non-negative> spalloc (1, 1, -1)
ff0eadb417ec Add BIST tests to sparse.cc (patch #9011).
Rik <rik@octave.org>
parents: 25646
diff changeset
326 */
29958
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29569
diff changeset
327
32c3a5805893 move DEFUN and DEFMETHOD functions inside octave namespace
John W. Eaton <jwe@octave.org>
parents: 29569
diff changeset
328 OCTAVE_NAMESPACE_END