octave-nkf: src/DLD-FUNCTIONS/sparse.cc annotate

annotate src/DLD-FUNCTIONS/sparse.cc @ 10521:4d1fc073fbb7

add some missing copyright stmts

author	Jaroslav Hajek <highegg@gmail.com>
date	Wed, 14 Apr 2010 12:23:13 +0200
parents	c5005bc2b7a9
children	b4d2080b6df7

rev	line source
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	1 /*
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	2
8920 eb63fbe60fab update copyright notices John W. Eaton <jwe@octave.org> parents: 8910 diff changeset	3 Copyright (C) 2004, 2005, 2006, 2007, 2008, 2009 David Bateman
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	4 Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004 Andy Adler
10521 4d1fc073fbb7 add some missing copyright stmts Jaroslav Hajek <highegg@gmail.com> parents: 10513 diff changeset	5 Copyright (C) 2010 VZLU Prague
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	6
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	7 This file is part of Octave.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	8
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	9 Octave is free software; you can redistribute it and/or modify it
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	10 under the terms of the GNU General Public License as published by the
7016 93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	11 Free Software Foundation; either version 3 of the License, or (at your
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	12 option) any later version.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	13
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	14 Octave is distributed in the hope that it will be useful, but WITHOUT
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	15 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	16 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	17 for more details.
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	18
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	19 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: 7001 diff changeset	20 along with Octave; see the file COPYING. If not, see
93c65f2a5668 [project @ 2007-10-12 06:40:56 by jwe] jwe parents: 7001 diff changeset	21 <http://www.gnu.org/licenses/>.
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	22
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	23 */
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	24
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	25 #ifdef HAVE_CONFIG_H
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	26 #include <config.h>
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	27 #endif
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	28
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	29 #include <cstdlib>
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	30 #include <string>
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	31
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	32 #include "variables.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	33 #include "utils.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	34 #include "pager.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	35 #include "defun-dld.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	36 #include "gripes.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	37 #include "quit.h"
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	38 #include "unwind-prot.h"
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	39
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	40 #include "ov-re-sparse.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	41 #include "ov-cx-sparse.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	42 #include "ov-bool-sparse.h"
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	43
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	44 DEFUN_DLD (issparse, args, ,
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	45 "-- texinfo --\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	46 @deftypefn {Loadable Function} {} issparse (@var{expr})\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	47 Return 1 if the value of the expression @var{expr} is a sparse matrix.\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	48 @end deftypefn")
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	49 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	50 if (args.length() != 1)
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	51 {
5823 080c08b192d8 [project @ 2006-05-19 05:32:17 by jwe] jwe parents: 5760 diff changeset	52 print_usage ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	53 return octave_value ();
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	54 }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	55 else
7515 f3c00dc0912b Eliminate the rest of the dispatched sparse functions David Bateman <dbateman@free.fr> parents: 7505 diff changeset	56 return octave_value (args(0).is_sparse_type ());
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	57 }
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 DEFUN_DLD (sparse, args, ,
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	60 "-- texinfo --\n\
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	61 @deftypefn {Loadable Function} {@var{s} =} sparse (@var{a})\n\
8106 8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	62 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv}, @var{m}, @var{n}, @var{nzmax})\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	63 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{sv})\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	64 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{i}, @var{j}, @var{s}, @var{m}, @var{n}, \"unique\")\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	65 @deftypefnx {Loadable Function} {@var{s} =} sparse (@var{m}, @var{n})\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	66 Create a sparse matrix from the full matrix or row, column, value triplets.\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	67 If @var{a} is a full matrix, convert it to a sparse matrix representation,\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	68 removing all zero values in the process.\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	69 \n\
8106 8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	70 Given the integer index vectors @var{i} and @var{j}, a 1-by-@code{nnz} vector\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	71 of real of complex values @var{sv}, overall dimensions @var{m} and @var{n}\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	72 of the sparse matrix. The argument @code{nzmax} is ignored but accepted for\n\
9064 7c02ec148a3c Check grammar on all .cc files Rik <rdrider0-list@yahoo.com> parents: 8920 diff changeset	73 compatibility with @sc{matlab}. If @var{m} or @var{n} are not specified their\n\
8106 8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	74 values are derived from the maximum index in the vectors @var{i} and @var{j}\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	75 as given by @code{@var{m} = max (@var{i})}, @code{@var{n} = max (@var{j})}.\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	76 \n\
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	77 @strong{Note}: if multiple values are specified with the same\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	78 @var{i}, @var{j} indices, the corresponding values in @var{s} will\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	79 be added.\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	80 \n\
6557 9883cb21e2aa [project @ 2007-04-20 19:18:13 by jwe] jwe parents: 6556 diff changeset	81 The following are all equivalent:\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	82 \n\
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	83 @example\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	84 @group\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	85 s = sparse (i, j, s, m, n)\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	86 s = sparse (i, j, s, m, n, \"summation\")\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	87 s = sparse (i, j, s, m, n, \"sum\")\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	88 @end group\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	89 @end example\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	90 \n\
8106 8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	91 Given the option \"unique\". if more than two values are specified for the\n\
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	92 same @var{i}, @var{j} indices, the last specified value will be used.\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	93 \n\
8106 8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	94 @code{sparse(@var{m}, @var{n})} is equivalent to\n\
8a42498edb30 Clarify doc for sparse function David Bateman <dbateman@free.fr> parents: 7515 diff changeset	95 @code{sparse ([], [], [], @var{m}, @var{n}, 0)}\n\
6556 8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	96 \n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	97 If any of @var{sv}, @var{i} or @var{j} are scalars, they are expanded\n\
8810bbf321ce [project @ 2007-04-20 18:39:40 by jwe] jwe parents: 6547 diff changeset	98 to have a common size.\n\
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	99 @seealso{full}\n\
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	100 @end deftypefn")
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	101 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	102 octave_value retval;
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	103 int nargin = args.length ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	104
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	105 // Temporarily disable sparse_auto_mutate if set (it's obsolete anyway).
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	106 unwind_protect frame;
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	107 frame.protect_var (Vsparse_auto_mutate);
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	108 Vsparse_auto_mutate = false;
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	109
7287 3f29467c1667 [project @ 2007-12-11 17:03:32 by jwe] jwe parents: 7017 diff changeset	110 if (nargin == 1)
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	111 {
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	112 octave_value arg = args (0);
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	113 if (arg.is_bool_type ())
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	114 retval = arg.sparse_bool_matrix_value ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	115 else if (arg.is_complex_type ())
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	116 retval = arg.sparse_complex_matrix_value ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	117 else if (arg.is_numeric_type ())
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	118 retval = arg.sparse_matrix_value ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	119 else
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	120 gripe_wrong_type_arg ("sparse", arg);
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	121 }
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	122 else if (nargin == 2)
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	123 {
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	124 octave_idx_type m = 0, n = 0;
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	125 if (args(0).is_scalar_type () && args(1).is_scalar_type ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	126 {
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	127 m = args(0).idx_type_value ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	128 n = args(1).idx_type_value ();
8910 6e9f26506804 optimize diag -> sparse and perm -> sparse conversions Jaroslav Hajek <highegg@gmail.com> parents: 8458 diff changeset	129 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	130 else
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	131 error ("sparse: expecting scalar dimensions");
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	132
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	133 if (! error_state)
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	134 {
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	135 if (m >= 0 && n >= 0)
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	136 retval = SparseMatrix (m, n);
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	137 else
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	138 error ("sparse: dimensions must be nonnegative");
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	139 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	140 }
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	141 else if (nargin >= 3)
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	142 {
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	143 bool summation = true;
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	144 if (nargin > 3 && args(nargin-1).is_string ())
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	145 {
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	146 std::string opt = args(nargin-1).string_value ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	147 if (opt == "unique")
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	148 summation = false;
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	149 else if (opt == "sum" \|\| opt == "summation")
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	150 summation = true;
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	151 else
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	152 error ("sparse: invalid option: %s", opt.c_str ());
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	153
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	154 nargin -= 1;
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	155 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	156
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	157 if (! error_state)
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	158 {
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	159 octave_idx_type m = -1, n = -1;
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	160 if (nargin == 5)
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	161 {
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	162 if (args(3).is_scalar_type () && args(4).is_scalar_type ())
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	163 {
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	164 m = args(3).idx_type_value ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	165 n = args(4).idx_type_value ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	166 }
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	167 else
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	168 error ("sparse: expecting scalar dimensions");
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	169
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	170
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	171 if (! error_state && (m < 0 \|\| n < 0))
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	172 error ("sparse: dimensions must be nonnegative");
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	173 }
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	174 else if (nargin != 3)
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	175 print_usage ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	176
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	177 if (! error_state)
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	178 {
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	179 idx_vector i = args(0).index_vector ();
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	180 idx_vector j = args(1).index_vector ();
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	181
10479 ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	182 if (args(2).is_bool_type ())
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	183 retval = SparseBoolMatrix (args(2).bool_array_value (), i, j,
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	184 m, n, summation);
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	185 else if (args(2).is_complex_type ())
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	186 retval = SparseComplexMatrix (args(2).complex_array_value (), i, j,
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	187 m, n, summation);
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	188 else if (args(2).is_numeric_type ())
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	189 retval = SparseMatrix (args(2).array_value (), i, j,
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	190 m, n, summation);
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	191 else
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	192 gripe_wrong_type_arg ("sparse", args(2));
ded9beac7582 optimize sparse matrix assembly Jaroslav Hajek <highegg@gmail.com> parents: 10155 diff changeset	193 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	194
10154 40dfc0c99116 DLD-FUNCTIONS/.cc: untabify John W. Eaton <jwe@octave.org>* parents: 9064 diff changeset	195 }
5164 57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	196 }
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	197
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	198 return retval;
57077d0ddc8e [project @ 2005-02-25 19:55:24 by jwe] jwe parents: diff changeset	199 }
10513 c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	200
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	201 DEFUN_DLD (spalloc, args, ,
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	202 "-- texinfo --\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	203 @deftypefn {Loadable Function} {@var{s} =} spalloc (@var{m}, @var{n}, @var{nz})\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	204 Creates a @var{m}-by-@var{n} sparse matrix with preallocated space for at most\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	205 @var{nz} nonzero elements. This is useful for building the matrix incrementally\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	206 by a sequence of indexed assignments. Subsequent indexed assignments will reuse\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	207 the pre-allocated memory, provided they are of one of the simple forms\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	208 \n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	209 @itemize\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	210 @item @code{@var{s}(I:J) = @var{x}}\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	211 @item @code{@var{s}(:,I:J) = @var{x}}\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	212 @item @code{@var{s}(K:L,I:J) = @var{x}}\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	213 @end itemize\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	214 \n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	215 @b{and} that the following conditions are met:\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	216 \n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	217 @itemize\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	218 @item the assignment does not decrease nnz(@var{S}).\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	219 @item after the assignment, nnz(@var{S}) does not exceed @var{nz}.\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	220 @item no index is out of bounds.\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	221 @end itemize\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	222 \n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	223 Partial movement of data may still occur, but in general the assignment will be more\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	224 memory and time-efficient under these circumstances. In particular, it is possible\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	225 to efficiently build a pre-allocated sparse matrix from contiguous block of columns.\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	226 \n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	227 The amount of preallocated memory for a given matrix may be queried using the function\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	228 @code{nzmax}.\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	229 @seealso{nzmax, sparse}\n\
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	230 @end deftypefn")
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	231 {
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	232 octave_value retval;
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	233 int nargin = args.length ();
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	234
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	235 if (nargin == 2 \|\| nargin == 3)
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	236 {
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	237 octave_idx_type m = args(0).idx_type_value ();
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	238 octave_idx_type n = args(1).idx_type_value ();
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	239 octave_idx_type nz = 0;
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	240 if (nargin == 3)
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	241 nz = args(2).idx_type_value ();
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	242 if (error_state)
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	243 ;
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	244 else if (m >= 0 && n >= 0 && nz >= 0)
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	245 retval = SparseMatrix (dim_vector (m, n), nz);
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	246 else
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	247 error ("spalloc: m,n,nz must be non-negative");
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	248 }
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	249 else
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	250 print_usage ();
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	251
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	252 return retval;
c5005bc2b7a9 implement working spalloc Jaroslav Hajek <highegg@gmail.com> parents: 10479 diff changeset	253 }

Mercurial > hg > octave-nkf

annotate src/DLD-FUNCTIONS/sparse.cc @ 10521:4d1fc073fbb7